Skip to content

docs: update examples & docs#3

Merged
xseman merged 3 commits into
masterfrom
example-updates
Apr 10, 2026
Merged

docs: update examples & docs#3
xseman merged 3 commits into
masterfrom
example-updates

Conversation

@xseman
Copy link
Copy Markdown
Owner

@xseman xseman commented Apr 10, 2026

No description provided.

@xseman xseman self-assigned this Apr 10, 2026
@xseman xseman requested a review from Copilot April 10, 2026 07:13
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 10, 2026

Coverage Report

Project coverage is 76.13%. Comparing base (c91f44b) to head (0284d53).

@@           Coverage Diff            @@
##            base    head    +/-     ##
  Coverage  76.13%  76.13%  0.00%
========================================
  Files         26      26      0
  Lines       2044    2044      0
========================================
  Hits        1556    1556      0
========================================
 35.66% ( 46/129) src/adapters/class-validator.ts
 79.79% ( 75/ 94) src/adapters/typebox.ts
 98.77% (160/162) src/container.ts
 83.33% ( 10/ 12) src/controller.ts
 65.45% ( 36/ 55) src/decorators/args.ts
100.00% ( 12/ 12) src/decorators/guard.ts
 93.33% ( 28/ 30) src/decorators/inject.ts
100.00% ( 12/ 12) src/decorators/interceptor.ts
 95.45% ( 21/ 22) src/decorators/meta.ts
100.00% ( 11/ 11) src/decorators/middleware.ts
 94.12% ( 16/ 17) src/decorators/params.ts
 33.33% (  1/  3) src/decorators/render.ts
 85.71% ( 12/ 14) src/decorators/response.ts
100.00% (  4/  4) src/decorators/route.ts
100.00% ( 12/ 12) src/decorators/security.ts
100.00% ( 12/ 12) src/decorators/verbs.ts
 75.16% (118/157) src/exceptions.ts
100.00% ( 20/ 20) src/index.ts
 91.67% ( 66/ 72) src/metadata.ts
 95.54% (107/112) src/module-tree.ts
 66.67% ( 26/ 39) src/module-viewer/internal.ts
  3.23% (  2/ 62) src/module-viewer/svg.ts
100.00% ( 85/ 85) src/module.ts
 97.35% (184/189) src/openapi.ts
 71.69% (476/664) src/router.ts
  9.30% (  4/ 43) src/view-engine.ts

Bun Coverage: 76.13%

Generated at 2026-04-10T07:38:47.156Z by coverage

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR refreshes the repository’s documentation and runnable examples by moving to a numbered “learning path” set of examples (from hello-world through auth and TypeORM relations), updating guide links accordingly, and adjusting a few dependencies to support the new examples.

Changes:

  • Renumber/restructure examples into examples/01_*examples/14_*, adding new auth + TypeORM examples and removing legacy unnumbered example folders/files.
  • Update docs to point at the new numbered examples and refresh example descriptions.
  • Update dependencies (e.g., decorator-toolkit bump and jose addition) used by new examples.

Reviewed changes

Copilot reviewed 91 out of 137 changed files in this pull request and generated 17 comments.

Show a summary per file
File Description
package.json Updates project description, bumps decorator-toolkit, adds jose.
examples/security/server.ts Removes legacy security example (superseded by numbered guards/jwt examples).
examples/security/package.json Removes legacy security example package manifest.
examples/security/controller.ts Removes legacy security controller (superseded by numbered examples).
examples/mvc/views/index.hbs Removes legacy MVC view (replaced by examples/10_mvc).
examples/mvc/views/about.hbs Removes legacy MVC view (replaced by examples/10_mvc).
examples/multi-controller/package.json Removes legacy example manifest (replaced by examples/03_multi-controller).
examples/modules/package.json Removes legacy example manifest (replaced by examples/05_modules).
examples/guards/controller.ts Removes legacy guards controller (replaced by examples/06_guards/controllers.ts).
examples/class-validator/models.ts Removes legacy class-validator example models (superseded by numbered examples).
examples/class-validator/controller.ts Removes legacy class-validator example controller (superseded by numbered examples).
examples/14_session-auth/views/register.hbs Adds session-auth register page.
examples/14_session-auth/views/login.hbs Adds session-auth login page.
examples/14_session-auth/views/dashboard.hbs Adds session-auth protected dashboard page.
examples/14_session-auth/tsconfig.json Adds TS config for the session-auth example.
examples/14_session-auth/session-store.ts Adds in-memory session store for server-side sessions.
examples/14_session-auth/server.ts Adds runnable server wiring for session-auth example (TypeORM + views).
examples/14_session-auth/schemas.ts Adds DTOs for session-auth example.
examples/14_session-auth/package.json Adds session-auth example manifest and dependencies.
examples/14_session-auth/entities/user.entity.ts Adds TypeORM User entity for session-auth example.
examples/14_session-auth/data-source.ts Adds sql.js TypeORM DataSource setup for session-auth example.
examples/14_session-auth/bun.lock Adds lockfile for session-auth example.
examples/14_session-auth/auth.service.ts Adds auth service for session-auth (register/login).
examples/14_session-auth/auth.controller.ts Adds session-auth controller + guard + cookie helpers.
examples/13_typeorm-relations/user.service.ts Adds TypeORM relations service layer (users/posts) example.
examples/13_typeorm-relations/tsconfig.json Adds TS config for the relations example.
examples/13_typeorm-relations/server.ts Adds runnable server for relations example.
examples/13_typeorm-relations/schemas.ts Adds DTOs for relations example.
examples/13_typeorm-relations/package.json Adds relations example manifest and dependencies.
examples/13_typeorm-relations/entities/user.entity.ts Adds User entity with @OneToMany posts relation.
examples/13_typeorm-relations/entities/post.entity.ts Adds Post entity with @ManyToOne author relation + cascade delete.
examples/13_typeorm-relations/data-source.ts Adds TypeORM DataSource for relations example.
examples/13_typeorm-relations/controllers.ts Adds controllers for nested routes and published feed example.
examples/13_typeorm-relations/bun.lock Adds lockfile for relations example.
examples/12_form-auth/views/register.hbs Adds form-auth register page.
examples/12_form-auth/views/login.hbs Adds form-auth login page.
examples/12_form-auth/views/dashboard.hbs Adds form-auth protected dashboard page.
examples/12_form-auth/user.service.ts Adds JWT issuing/verification with jose.
examples/12_form-auth/tsconfig.json Adds TS config for the form-auth example.
examples/12_form-auth/server.ts Adds runnable server for form-auth (TypeORM + views).
examples/12_form-auth/package.json Adds form-auth example manifest and dependencies.
examples/12_form-auth/entities/user.entity.ts Adds TypeORM User entity for form-auth example.
examples/12_form-auth/data-source.ts Adds TypeORM DataSource for form-auth example.
examples/12_form-auth/controller.ts Adds controller + cookie guard for JWT-in-cookie flow.
examples/11_jwt-auth/tsconfig.json Formatting tweak (consistent line numbering) for example TS config.
examples/11_jwt-auth/server.ts Adds runnable JWT bearer auth example server.
examples/11_jwt-auth/schemas.ts Adds DTOs for JWT auth example.
examples/11_jwt-auth/package.json Adds JWT auth example manifest and dependencies.
examples/11_jwt-auth/entities/user.entity.ts Adds TypeORM User entity for JWT auth example.
examples/11_jwt-auth/data-source.ts Adds TypeORM DataSource for JWT auth example.
examples/11_jwt-auth/auth.service.ts Adds auth service with rate limiting, caching, and timeouts.
examples/11_jwt-auth/auth.controller.ts Adds auth controller with /register, /login, /me.
examples/10_mvc/views/index.hbs Adds numbered MVC home view.
examples/10_mvc/views/about.hbs Adds numbered MVC about view.
examples/10_mvc/tsconfig.json Formatting tweak (consistent line numbering) for example TS config.
examples/10_mvc/server.ts Adds runnable MVC server using Handlebars adapter.
examples/10_mvc/package.json Renames package to numbered 10-mvc variant.
examples/10_mvc/controller.ts Adds controller demonstrating @Render.
examples/10_mvc/bun.lock Adds lockfile for numbered MVC example.
examples/09_complex/users.module.ts Adds users module demonstrating module composition + DI.
examples/09_complex/tsconfig.json Adds TS config for complex example.
examples/09_complex/server.ts Updates OpenAPI service metadata and exports a middleware example.
examples/09_complex/posts.module.ts Adds posts module demonstrating middleware + cross-module DI.
examples/09_complex/package.json Adds complex example manifest.
examples/09_complex/database.module.ts Adds database module/service stub for module composition.
examples/09_complex/bun.lock Adds lockfile for complex example.
examples/09_complex/auth.module.ts Adds auth module demonstrating middleware + controller wiring.
examples/09_complex/app.module.ts Adds root AppModule composing submodules.
examples/08_logging/tsconfig.json Adds TS config for logging example.
examples/08_logging/service.ts Adds exec-time decorator usage for timing service methods.
examples/08_logging/server.ts Updates OpenAPI metadata and console output for logging example.
examples/08_logging/request-context.ts Adds AsyncLocalStorage request context middleware.
examples/08_logging/package.json Renames package to numbered 08-logging variant.
examples/08_logging/logger.ts Adds logger using request context + caller context.
examples/08_logging/controller.ts Adds controller demonstrating structured logging.
examples/08_logging/bun.lock Adds lockfile for logging example.
examples/07_interceptors/tsconfig.json Adds TS config for interceptors example.
examples/07_interceptors/server.ts Updates OpenAPI metadata for interceptors example.
examples/07_interceptors/package.json Renames package to numbered 07-interceptors variant.
examples/07_interceptors/controller.ts Adds interceptors example controller and interceptors.
examples/07_interceptors/bun.lock Adds lockfile for interceptors example.
examples/06_guards/tsconfig.json Formatting tweak (consistent line numbering) for example TS config.
examples/06_guards/server.ts Updates guards server to include admin controller + new metadata.
examples/06_guards/package.json Renames package to numbered 06-guards variant.
examples/06_guards/controllers.ts Adds consolidated controllers/DTOs/guards example.
examples/06_guards/bun.lock Adds lockfile for guards example.
examples/05_modules/tsconfig.json Adds TS config for modules example.
examples/05_modules/tree.ts Adds module tree printing helper example.
examples/05_modules/server.ts Updates OpenAPI metadata for modules example.
examples/05_modules/package.json Renames package to numbered 05-modules variant.
examples/05_modules/cat.service.ts Adds injectable service example.
examples/05_modules/cat.module.ts Adds module definition for cats feature.
examples/05_modules/cat.controller.ts Adds controller demonstrating service injection.
examples/05_modules/bun.lock Adds lockfile for modules example.
examples/05_modules/app.module.ts Adds root module wiring.
examples/04_dependency-injection/tsconfig.json Adds dedicated tsconfig for DI example (rootDir/include setup).
examples/04_dependency-injection/service.ts Adds service demonstrating caching decorator usage.
examples/04_dependency-injection/server.ts Updates OpenAPI metadata naming/description.
examples/04_dependency-injection/package.json Renames package to numbered 04-dependency-injection.
examples/04_dependency-injection/controller.ts Adds controller showing DI + token injection.
examples/04_dependency-injection/bun.lock Adds lockfile including decorator-toolkit.
examples/03_multi-controller/tsconfig.json Adds TS config for multi-controller example.
examples/03_multi-controller/server.ts Updates OpenAPI metadata naming/description.
examples/03_multi-controller/package.json Adds numbered example manifest.
examples/03_multi-controller/controllers.ts Adds multiple controllers demonstrating metadata decorators.
examples/03_multi-controller/bun.lock Adds lockfile for multi-controller example.
examples/02_crud/tsconfig.json Formatting tweak (consistent line numbering) for example TS config.
examples/02_crud/server.ts Updates OpenAPI metadata naming/description.
examples/02_crud/schemas.ts Adds extracted DTO schemas for CRUD example.
examples/02_crud/package.json Renames package to numbered 02-crud variant.
examples/02_crud/controller.ts Exports controller and tweaks delete handler return.
examples/02_crud/bun.lock Adds lockfile for CRUD example.
examples/01_hello-world/tsconfig.json Adds TS config for hello-world example.
examples/01_hello-world/server.ts Updates to minimal hello-world controller + metadata.
examples/01_hello-world/package.json Renames package to numbered 01-hello-world variant.
examples/01_hello-world/controller.ts Adds minimal hello controller.
examples/01_hello-world/bun.lock Adds lockfile for hello-world example.
docs/guides/view-rendering.md Updates link to numbered MVC example.
docs/guides/validation-and-schemas.md Updates example links to numbered CRUD example.
docs/guides/response-validation.md Updates link to numbered interceptors example.
docs/guides/request-binding.md Updates link to numbered CRUD controller.
docs/guides/openapi-and-swagger.md Updates link to numbered CRUD server.
docs/guides/modules.md Updates links to numbered modules/complex examples.
docs/guides/middleware.md Updates links to numbered logging example.
docs/guides/logging-and-caller-context.md Updates links to numbered logging example.
docs/guides/interceptors.md Updates link to numbered interceptors example.
docs/guides/guards-and-security.md Updates links to numbered guards example.
docs/guides/error-handling.md Updates link to numbered CRUD example.
docs/guides/descriptions-and-metadata.md Updates link to numbered multi-controller example.
docs/guides/dependency-injection.md Updates link to numbered DI example.
docs/guides/controllers-and-routes.md Updates links to numbered CRUD and multi-controller examples.
docs/getting-started.md Updates runnable example link to numbered CRUD example.
docs/examples/index.md Rewrites examples index table to the new numbered progression and updates run instructions.
docs/concepts/request-lifecycle.md Updates link to numbered logging example.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread examples/14_session-auth/views/register.hbs
Comment thread examples/14_session-auth/views/login.hbs
Comment thread examples/14_session-auth/auth.controller.ts
Comment thread examples/14_session-auth/auth.controller.ts
Comment thread examples/14_session-auth/auth.controller.ts
Comment thread examples/12_form-auth/controller.ts
Comment thread examples/11_jwt-auth/auth.service.ts
Comment thread examples/11_jwt-auth/auth.service.ts
Comment thread examples/11_jwt-auth/auth.controller.ts
Comment thread examples/13_typeorm-relations/schemas.ts
@xseman xseman merged commit ccd0507 into master Apr 10, 2026
2 checks passed
@xseman xseman mentioned this pull request Apr 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants