@lenne.tech/nest-server 11.22.0 → 11.22.1

package/migration-guides/11.22.0-to-11.22.1.md

@@ -0,0 +1,105 @@
+# Migration Guide: 11.22.0 → 11.22.1
+
+## Overview
+
+| Category | Details |
+|----------|---------|
+| **Breaking Changes** | None |
+| **New Features** | `FRAMEWORK-API.md` — auto-generated compact API reference shipped with npm package |
+| **Bugfixes** | Security override updates (minimatch, undici, srvx, path-to-regexp) |
+| **Dependency Updates** | NestJS 11.1.18, mongoose 9.4.1 |
+| **Migration Effort** | ~2 minutes (optional, backward compatible) |
+
+---
+
+## Quick Migration (No Breaking Changes)
+
+```bash
+# Update package
+pnpm add @lenne.tech/nest-server@11.22.1
+
+# Verify build
+pnpm run build
+
+# Run tests
+pnpm test
+```
+
+No code changes required. All existing patterns continue to work.
+
+---
+
+## What's New in 11.22.1
+
+### 1. FRAMEWORK-API.md — Auto-Generated API Reference
+
+The npm package now ships a compact, machine-readable API reference (`FRAMEWORK-API.md`) that is
+auto-generated from source code during `pnpm run build`. It contains:
+
+- `CoreModule.forRoot()` overload signatures
+- All configuration interfaces (`IServerOptions`, `IBetterAuth`, `IMultiTenancy`, etc.) with types and defaults
+- `ServiceOptions` interface
+- `CrudService` public method signatures
+- Core module listing with documentation status
+
+**For AI-assisted development:** Update your project's `CLAUDE.md` to reference this file:
+
+```markdown
+## Framework: @lenne.tech/nest-server
+When working with framework features, read source and docs from:
+node_modules/@lenne.tech/nest-server/CLAUDE.md
+node_modules/@lenne.tech/nest-server/FRAMEWORK-API.md
+node_modules/@lenne.tech/nest-server/src/core/modules/*/INTEGRATION-CHECKLIST.md
+```
+
+This enables AI tools to quickly understand the framework's complete API surface without
+reading every source file individually.
+
+### 2. Dependency Updates
+
+| Package | From | To | Type |
+|---------|------|----|------|
+| `@nestjs/common` | 11.1.17 | 11.1.18 | patch |
+| `@nestjs/core` | 11.1.17 | 11.1.18 | patch |
+| `@nestjs/platform-express` | 11.1.17 | 11.1.18 | patch |
+| `@nestjs/websockets` | 11.1.17 | 11.1.18 | patch |
+| `@nestjs/testing` (dev) | 11.1.17 | 11.1.18 | patch |
+| `mongoose` | 9.3.3 | 9.4.1 | minor |
+
+### 3. Security Override Updates
+
+Updated security overrides to latest patched versions:
+
+| Override | From | To |
+|----------|------|----|
+| `minimatch` | 3.1.4 / 9.0.7 / 10.2.4 | 3.1.5 / 9.0.9 / 10.2.5 |
+| `undici` | 7.24.3 | 7.24.7 |
+| `srvx` | 0.11.13 | 0.11.15 |
+| `path-to-regexp` | 8.4.1 | 8.4.2 |
+
+---
+
+## Compatibility Notes
+
+| Pattern | Status |
+|---------|--------|
+| All existing `CoreModule.forRoot()` patterns | Works unchanged |
+| `ICoreModuleOverrides` from 11.22.0 | Works unchanged |
+| mongoose queries and schemas | Compatible (9.4.1 is backward compatible) |
+
+---
+
+## Troubleshooting
+
+| Issue | Solution |
+|-------|----------|
+| `FRAMEWORK-API.md` not found in `node_modules` | Ensure `@lenne.tech/nest-server@11.22.1` is installed |
+| Override conflicts after update | Run `pnpm install` to apply updated lockfile |
+
+---
+
+## References
+
+- [FRAMEWORK-API.md](../FRAMEWORK-API.md) — The new API reference
+- [Framework Compatibility Rules](../.claude/rules/framework-compatibility.md) — Maintenance obligations
+- [nest-server-starter](https://github.com/lenneTech/nest-server-starter) (reference implementation)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lenne.tech/nest-server",
-  "version": "11.22.0",
+  "version": "11.22.1",
   "description": "Modern, fast, powerful Node.js web framework in TypeScript based on Nest with a GraphQL API and a connection to MongoDB (or other databases).",
   "keywords": [
     "node",
@@ -14,7 +14,8 @@
   "homepage": "https://github.com/lenneTech/nest-server",
   "license": "MIT",
   "scripts": {
-    "build": "rimraf dist && nest build && pnpm run build:copy-types && pnpm run build:copy-templates && pnpm run build:add-type-references",
+    "build": "rimraf dist && nest build && pnpm run build:copy-types && pnpm run build:copy-templates && pnpm run build:add-type-references && pnpm run build:framework-api",
+    "build:framework-api": "npx tsx scripts/generate-framework-api.ts",
     "build:copy-types": "mkdir -p dist/types && cp src/types/*.d.ts dist/types/",
     "build:copy-templates": "mkdir -p dist/core/modules/migrate/templates && cp src/core/modules/migrate/templates/migration-project.template.ts dist/core/modules/migrate/templates/",
     "build:add-type-references": "node scripts/add-type-references.js",
@@ -78,17 +79,17 @@
     "@better-auth/passkey": "1.5.5",
     "@getbrevo/brevo": "3.0.1",
     "@nestjs/apollo": "13.2.4",
-    "@nestjs/common": "11.1.17",
-    "@nestjs/core": "11.1.17",
+    "@nestjs/common": "11.1.18",
+    "@nestjs/core": "11.1.18",
     "@nestjs/graphql": "13.2.4",
     "@nestjs/jwt": "11.0.2",
     "@nestjs/mongoose": "11.0.4",
     "@nestjs/passport": "11.0.5",
-    "@nestjs/platform-express": "11.1.17",
+    "@nestjs/platform-express": "11.1.18",
     "@nestjs/schedule": "6.1.1",
     "@nestjs/swagger": "11.2.6",
     "@nestjs/terminus": "11.1.1",
-    "@nestjs/websockets": "11.1.17",
+    "@nestjs/websockets": "11.1.18",
     "@tus/file-store": "2.0.0",
     "@tus/server": "2.3.0",
     "bcrypt": "6.0.0",
@@ -108,7 +109,7 @@
     "json-to-graphql-query": "2.3.0",
     "lodash": "4.18.1",
     "mongodb": "7.1.1",
-    "mongoose": "9.3.3",
+    "mongoose": "9.4.1",
     "multer": "2.1.1",
     "node-mailjet": "6.0.11",
     "nodemailer": "8.0.4",
@@ -124,16 +125,16 @@
     "@compodoc/compodoc": "1.2.1",
     "@nestjs/cli": "11.0.17",
     "@nestjs/schematics": "11.0.10",
-    "@nestjs/testing": "11.1.17",
+    "@nestjs/testing": "11.1.18",
     "@swc/cli": "0.8.1",
-    "@swc/core": "1.15.21",
+    "@swc/core": "1.15.24",
     "@types/compression": "1.8.1",
     "@types/cookie-parser": "1.4.10",
     "@types/ejs": "3.1.5",
     "@types/express": "5.0.6",
     "@types/lodash": "4.17.24",
     "@types/multer": "2.1.0",
-    "@types/node": "25.5.0",
+    "@types/node": "25.5.2",
     "@types/nodemailer": "7.0.11",
     "@types/passport": "1.0.17",
     "@types/supertest": "7.2.0",
@@ -170,6 +171,7 @@
     "src/**/*",
     "bin/**/*",
     "CLAUDE.md",
+    "FRAMEWORK-API.md",
     ".claude/rules/**/*",
     "docs/**/*",
     "migration-guides/**/*"
@@ -180,20 +182,20 @@
   "packageManager": "pnpm@10.29.2",
   "pnpm": {
     "overrides": {
-      "minimatch@<3.1.4": "3.1.4",
-      "minimatch@>=9.0.0 <9.0.7": "9.0.7",
-      "minimatch@>=10.0.0 <10.2.3": "10.2.4",
+      "minimatch@<3.1.5": "3.1.5",
+      "minimatch@>=9.0.0 <9.0.9": "9.0.9",
+      "minimatch@>=10.0.0 <10.2.5": "10.2.5",
       "rollup@>=4.0.0 <4.60.1": "4.60.1",
       "ajv@<6.14.0": "6.14.0",
       "ajv@>=7.0.0-alpha.0 <8.18.0": "8.18.0",
-      "undici@>=7.0.0 <7.24.0": "7.24.3",
-      "srvx@<0.11.13": "0.11.13",
+      "undici@>=7.0.0 <7.24.7": "7.24.7",
+      "srvx@<0.11.15": "0.11.15",
       "handlebars@>=4.0.0 <4.7.9": "4.7.9",
       "brace-expansion@<1.1.13": "1.1.13",
       "brace-expansion@>=4.0.0 <5.0.5": "5.0.5",
       "picomatch@<2.3.2": "2.3.2",
       "picomatch@>=4.0.0 <4.0.4": "4.0.4",
-      "path-to-regexp@>=8.0.0 <8.4.0": "8.4.1",
+      "path-to-regexp@>=8.0.0 <8.4.2": "8.4.2",
       "kysely@>=0.26.0 <0.28.15": "0.28.15",
       "lodash@>=4.0.0 <4.18.0": "4.18.1",
       "defu@<=6.1.4": "6.1.6"