@ftisindia/create-app 0.1.2 → 0.1.4

package/template/src/modules/organisations/application/services/organisations.service.ts

@@ -1,30 +1,29 @@
-import { ConflictException, Injectable } from "@nestjs/common";
-import { Prisma } from "@prisma/client";
-import { PrismaService } from "../../../../database/prisma/prisma.service";
-import { AuthenticatedUser } from "../../../auth/types/authenticated-user";
-import { CreateOrganisationDto } from "../../dto/create-organisation.dto";
-import { OrganisationsRepository } from "../../infrastructure/repositories/organisations.repository";
+import { ConflictException, Injectable } from '@nestjs/common';
+import { Prisma } from '@prisma/client';
+import { PrismaService } from '../../../../database/prisma/prisma.service';
+import { RequestContextService } from '../../../request-context/application/services/request-context.service';
+import { AuthenticatedUser } from '../../../auth/types/authenticated-user';
+import { CreateOrganisationDto } from '../../dto/create-organisation.dto';
+import { OrganisationsRepository } from '../../infrastructure/repositories/organisations.repository';
 import {
   defaultOrganisationRoles,
   defaultOrganisationSettings,
-} from "../../types/default-organisation-data";
+} from '../../types/default-organisation-data';
 
 @Injectable()
 export class OrganisationsService {
   constructor(
     private readonly organisationsRepository: OrganisationsRepository,
     private readonly prisma: PrismaService,
+    private readonly requestContext: RequestContextService,
   ) {}
 
-  async createOrganisation(
-    currentUser: AuthenticatedUser,
-    dto: CreateOrganisationDto,
-  ) {
+  async createOrganisation(currentUser: AuthenticatedUser, dto: CreateOrganisationDto) {
     const name = dto.name.trim();
     const slug = dto.slug?.trim() || (await this.createAvailableSlug(name));
 
     if (dto.slug && (await this.organisationsRepository.findBySlug(slug))) {
-      throw new ConflictException("Organisation slug is already in use.");
+      throw new ConflictException('Organisation slug is already in use.');
     }
 
     try {
@@ -48,10 +47,10 @@ export class OrganisationsService {
             }),
           ),
         );
-        const ownerRole = roles.find((role) => role.name === "Owner");
+        const ownerRole = roles.find((role) => role.name === 'Owner');
 
         if (!ownerRole) {
-          throw new Error("Owner role was not seeded.");
+          throw new Error('Owner role was not seeded.');
         }
 
         const membership = await tx.membership.create({
@@ -80,8 +79,8 @@ export class OrganisationsService {
           data: {
             orgId: organisation.id,
             actorUserId: currentUser.id,
-            action: "organisation.create",
-            targetType: "Organisation",
+            action: 'organisation.create',
+            targetType: 'Organisation',
             targetId: organisation.id,
             metadata: {
               name: organisation.name,
@@ -89,6 +88,8 @@ export class OrganisationsService {
               defaultRoles: roles.map((role) => role.name),
               defaultSettings: settings.map((setting) => setting.key),
             },
+            ipAddress: this.requestContext.getIpAddress(),
+            userAgent: this.requestContext.getUserAgent(),
           },
         });
 
@@ -108,7 +109,7 @@ export class OrganisationsService {
       });
     } catch (error) {
       if (isPrismaUniqueError(error)) {
-        throw new ConflictException("Organisation slug is already in use.");
+        throw new ConflictException('Organisation slug is already in use.');
       }
 
       throw error;
@@ -130,18 +131,15 @@ export class OrganisationsService {
 }
 
 function isPrismaUniqueError(error: unknown) {
-  return (
-    error instanceof Prisma.PrismaClientKnownRequestError &&
-    error.code === "P2002"
-  );
+  return error instanceof Prisma.PrismaClientKnownRequestError && error.code === 'P2002';
 }
 
 function slugify(value: string) {
   const slug = value
     .trim()
     .toLowerCase()
-    .replace(/[^a-z0-9]+/g, "-")
-    .replace(/^-+|-+$/g, "");
+    .replace(/[^a-z0-9]+/g, '-')
+    .replace(/^-+|-+$/g, '');
 
   return slug || `org-${Date.now()}`;
 }

package/template/src/modules/organisations/dto/create-organisation.dto.ts

@@ -1,23 +1,16 @@
-import { ApiProperty, ApiPropertyOptional } from "@nestjs/swagger";
-import {
-  IsOptional,
-  IsString,
-  Matches,
-  MaxLength,
-  MinLength,
-} from "class-validator";
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import { IsOptional, IsString, Matches, MaxLength, MinLength } from 'class-validator';
 
 export class CreateOrganisationDto {
-  @ApiProperty({ example: "Acme Operations", minLength: 2, maxLength: 120 })
+  @ApiProperty({ example: 'Acme Operations', minLength: 2, maxLength: 120 })
   @IsString()
   @MinLength(2)
   @MaxLength(120)
   name!: string;
 
   @ApiPropertyOptional({
-    description:
-      "Optional URL-friendly slug. Generated from the name when omitted.",
-    example: "acme-operations",
+    description: 'Optional URL-friendly slug. Generated from the name when omitted.',
+    example: 'acme-operations',
     minLength: 2,
     maxLength: 80,
   })
@@ -26,7 +19,7 @@ export class CreateOrganisationDto {
   @MinLength(2)
   @MaxLength(80)
   @Matches(/^[a-z0-9][a-z0-9-]*$/, {
-    message: "slug must contain lowercase letters, numbers, and hyphens only",
+    message: 'slug must contain lowercase letters, numbers, and hyphens only',
   })
   slug?: string;
 }

package/template/src/modules/organisations/dto/organisation-response.dto.ts

@@ -1,38 +1,38 @@
-import { ApiProperty } from "@nestjs/swagger";
-import { OrganisationStatus } from "@prisma/client";
-import { MembershipResponseDto } from "../../../common/dto/membership-response.dto";
+import { ApiProperty } from '@nestjs/swagger';
+import { OrganisationStatus } from '@prisma/client';
+import { MembershipResponseDto } from '../../../common/dto/membership-response.dto';
 
 export class OrganisationResponseDto {
   @ApiProperty({
-    example: "2c67399d-670c-4025-a5fd-1ea9a211891e",
-    format: "uuid",
+    example: '2c67399d-670c-4025-a5fd-1ea9a211891e',
+    format: 'uuid',
   })
   id!: string;
 
-  @ApiProperty({ example: "Acme Operations" })
+  @ApiProperty({ example: 'Acme Operations' })
   name!: string;
 
-  @ApiProperty({ example: "acme-operations" })
+  @ApiProperty({ example: 'acme-operations' })
   slug!: string;
 
   @ApiProperty({ enum: OrganisationStatus, example: OrganisationStatus.ACTIVE })
   status!: OrganisationStatus;
 
-  @ApiProperty({ example: "2026-06-01T10:30:00.000Z", format: "date-time" })
+  @ApiProperty({ example: '2026-06-01T10:30:00.000Z', format: 'date-time' })
   createdAt!: string;
 
-  @ApiProperty({ example: "2026-06-01T10:30:00.000Z", format: "date-time" })
+  @ApiProperty({ example: '2026-06-01T10:30:00.000Z', format: 'date-time' })
   updatedAt!: string;
 }
 
 class SeededOrganisationRoleDto {
   @ApiProperty({
-    example: "f602c057-04f4-4ef8-8c84-1b7c62fbf8c5",
-    format: "uuid",
+    example: 'f602c057-04f4-4ef8-8c84-1b7c62fbf8c5',
+    format: 'uuid',
   })
   id!: string;
 
-  @ApiProperty({ example: "Owner" })
+  @ApiProperty({ example: 'Owner' })
   name!: string;
 
   @ApiProperty({ example: true })
@@ -40,10 +40,10 @@ class SeededOrganisationRoleDto {
 }
 
 class SeededOrganisationSettingDto {
-  @ApiProperty({ example: "timezone" })
+  @ApiProperty({ example: 'timezone' })
   key!: string;
 
-  @ApiProperty({ example: "UTC" })
+  @ApiProperty({ example: 'UTC' })
   value!: unknown;
 }
 

package/template/src/modules/organisations/infrastructure/repositories/organisations.repository.ts

@@ -1,6 +1,6 @@
-import { Injectable } from "@nestjs/common";
-import { Prisma } from "@prisma/client";
-import { PrismaService } from "../../../../database/prisma/prisma.service";
+import { Injectable } from '@nestjs/common';
+import { Prisma } from '@prisma/client';
+import { PrismaService } from '../../../../database/prisma/prisma.service';
 
 type PrismaClientLike = Prisma.TransactionClient | PrismaService;
 
@@ -15,10 +15,7 @@ export class OrganisationsRepository {
     });
   }
 
-  create(
-    data: Prisma.OrganisationCreateInput,
-    client: PrismaClientLike = this.prisma,
-  ) {
+  create(data: Prisma.OrganisationCreateInput, client: PrismaClientLike = this.prisma) {
     return client.organisation.create({ data });
   }
 }

package/template/src/modules/organisations/organisations.module.ts

@@ -1,8 +1,8 @@
-import { Module } from "@nestjs/common";
-import { AuthModule } from "../auth/auth.module";
-import { OrganisationsService } from "./application/services/organisations.service";
-import { OrganisationsRepository } from "./infrastructure/repositories/organisations.repository";
-import { OrganisationsController } from "./presentation/organisations.controller";
+import { Module } from '@nestjs/common';
+import { AuthModule } from '../auth/auth.module';
+import { OrganisationsService } from './application/services/organisations.service';
+import { OrganisationsRepository } from './infrastructure/repositories/organisations.repository';
+import { OrganisationsController } from './presentation/organisations.controller';
 
 @Module({
   imports: [AuthModule],

package/template/src/modules/organisations/presentation/organisations.controller.ts

@@ -1,37 +1,28 @@
-import { Body, Controller, Post, UseGuards } from "@nestjs/common";
-import {
-  ApiBearerAuth,
-  ApiCreatedResponse,
-  ApiOperation,
-  ApiTags,
-} from "@nestjs/swagger";
-import { ApiErrorResponses } from "../../../common/swagger/api-error-responses";
-import { JwtAuthGuard } from "../../auth/infrastructure/passport/jwt-auth.guard";
-import { CurrentUser } from "../../auth/presentation/current-user.decorator";
-import { AuthenticatedUser } from "../../auth/types/authenticated-user";
-import { OrganisationsService } from "../application/services/organisations.service";
-import { CreateOrganisationDto } from "../dto/create-organisation.dto";
-import { CreateOrganisationResponseDto } from "../dto/organisation-response.dto";
+import { Body, Controller, Post, UseGuards } from '@nestjs/common';
+import { ApiBearerAuth, ApiCreatedResponse, ApiOperation, ApiTags } from '@nestjs/swagger';
+import { ApiErrorResponses } from '../../../common/swagger/api-error-responses';
+import { JwtAuthGuard } from '../../auth/infrastructure/passport/jwt-auth.guard';
+import { CurrentUser } from '../../auth/presentation/current-user.decorator';
+import { AuthenticatedUser } from '../../auth/types/authenticated-user';
+import { OrganisationsService } from '../application/services/organisations.service';
+import { CreateOrganisationDto } from '../dto/create-organisation.dto';
+import { CreateOrganisationResponseDto } from '../dto/organisation-response.dto';
 
-@ApiTags("Organisations")
+@ApiTags('Organisations')
 @ApiBearerAuth()
-@Controller("organisations")
+@Controller('organisations')
 export class OrganisationsController {
   constructor(private readonly organisationsService: OrganisationsService) {}
 
   @Post()
   @UseGuards(JwtAuthGuard)
-  @ApiOperation({ summary: "Create an organisation for the current user." })
+  @ApiOperation({ summary: 'Create an organisation for the current user.' })
   @ApiCreatedResponse({
-    description:
-      "Organisation created with default roles, settings, and owner membership.",
+    description: 'Organisation created with default roles, settings, and owner membership.',
     type: CreateOrganisationResponseDto,
   })
   @ApiErrorResponses(400, 401, 409)
-  create(
-    @CurrentUser() user: AuthenticatedUser,
-    @Body() dto: CreateOrganisationDto,
-  ) {
+  create(@CurrentUser() user: AuthenticatedUser, @Body() dto: CreateOrganisationDto) {
     return this.organisationsService.createOrganisation(user, dto);
   }
 }

package/template/src/modules/organisations/types/default-organisation-data.ts

@@ -1,13 +1,7 @@
-import { Prisma } from "@prisma/client";
-import { settingDefinitions } from "../../settings/types/setting-definitions";
+import { Prisma } from '@prisma/client';
+import { settingDefinitions } from '../../settings/types/setting-definitions';
 
-export const defaultOrganisationRoles = [
-  "Owner",
-  "Admin",
-  "Manager",
-  "Staff",
-  "Viewer",
-] as const;
+export const defaultOrganisationRoles = ['Owner', 'Admin', 'Manager', 'Staff', 'Viewer'] as const;
 
 export const defaultOrganisationSettings: Array<{
   key: string;

package/template/src/modules/request-context/application/services/request-context.service.ts

@@ -1,7 +1,7 @@
-import { AsyncLocalStorage } from "async_hooks";
-import { randomUUID } from "crypto";
-import { ForbiddenException, Injectable } from "@nestjs/common";
-import { RequestContext } from "../../types/request-context";
+import { AsyncLocalStorage } from 'async_hooks';
+import { randomUUID } from 'crypto';
+import { ForbiddenException, Injectable } from '@nestjs/common';
+import { RequestContext } from '../../types/request-context';
 
 @Injectable()
 export class RequestContextService {
@@ -11,7 +11,7 @@ export class RequestContextService {
     return this.storage.run(
       {
         requestId: context.requestId ?? randomUUID(),
-        source: context.source ?? "worker",
+        source: context.source ?? 'worker',
         startedAt: context.startedAt ?? new Date(),
         ...context,
       },
@@ -51,6 +51,14 @@ export class RequestContextService {
     return this.get()?.rbac?.roleId;
   }
 
+  getIpAddress() {
+    return this.get()?.ipAddress;
+  }
+
+  getUserAgent() {
+    return this.get()?.userAgent;
+  }
+
   getPermissions() {
     return this.get()?.rbac?.permissionKeys ?? [];
   }
@@ -67,12 +75,12 @@ export class RequestContextService {
   assertOrgScope(orgId: string) {
     const activeOrgId = this.getOrgId();
     if (!activeOrgId) {
-      throw new ForbiddenException("Active organisation context is required.");
+      throw new ForbiddenException('Active organisation context is required.');
     }
 
     if (activeOrgId !== orgId) {
       throw new ForbiddenException(
-        "Request organisation context does not match the requested resource.",
+        'Request organisation context does not match the requested resource.',
       );
     }
   }

package/template/src/modules/request-context/presentation/org-scope.guard.ts

@@ -1,11 +1,6 @@
-import {
-  CanActivate,
-  ExecutionContext,
-  ForbiddenException,
-  Injectable,
-} from "@nestjs/common";
-import { RequestContextService } from "../application/services/request-context.service";
-import { RequestWithContext } from "../types/request-context";
+import { CanActivate, ExecutionContext, ForbiddenException, Injectable } from '@nestjs/common';
+import { RequestContextService } from '../application/services/request-context.service';
+import { RequestWithContext } from '../types/request-context';
 
 @Injectable()
 export class OrgScopeGuard implements CanActivate {
@@ -16,7 +11,7 @@ export class OrgScopeGuard implements CanActivate {
     const orgId = request.params?.orgId;
 
     if (!orgId) {
-      throw new ForbiddenException("Organisation context is required.");
+      throw new ForbiddenException('Organisation context is required.');
     }
 
     request.orgId = orgId;

package/template/src/modules/request-context/presentation/request-context.interceptor.ts

@@ -1,12 +1,7 @@
-import {
-  CallHandler,
-  ExecutionContext,
-  Injectable,
-  NestInterceptor,
-} from "@nestjs/common";
-import { Observable } from "rxjs";
-import { RequestContextService } from "../application/services/request-context.service";
-import { RequestWithContext } from "../types/request-context";
+import { CallHandler, ExecutionContext, Injectable, NestInterceptor } from '@nestjs/common';
+import { Observable } from 'rxjs';
+import { RequestContextService } from '../application/services/request-context.service';
+import { RequestWithContext } from '../types/request-context';
 
 @Injectable()
 export class RequestContextInterceptor implements NestInterceptor {

package/template/src/modules/request-context/presentation/request-context.middleware.ts

@@ -1,25 +1,24 @@
-import { Injectable, NestMiddleware } from "@nestjs/common";
-import { randomUUID } from "crypto";
-import { RequestContextService } from "../application/services/request-context.service";
-import { RequestWithContext } from "../types/request-context";
+import { Injectable, NestMiddleware } from '@nestjs/common';
+import { randomUUID } from 'crypto';
+import { RequestContextService } from '../application/services/request-context.service';
+import { RequestWithContext } from '../types/request-context';
 
 @Injectable()
 export class RequestContextMiddleware implements NestMiddleware {
   constructor(private readonly requestContext: RequestContextService) {}
 
   use(request: RequestWithContext, _response: unknown, next: () => void) {
-    const requestId =
-      headerAsString(request.headers?.["x-request-id"]) || randomUUID();
+    const requestId = headerAsString(request.headers?.['x-request-id']) || randomUUID();
 
     this.requestContext.run(
       {
         requestId,
-        source: "http",
+        source: 'http',
         startedAt: new Date(),
         method: request.method,
         path: request.originalUrl ?? request.url,
         ipAddress: request.ip,
-        userAgent: headerAsString(request.headers?.["user-agent"]),
+        userAgent: headerAsString(request.headers?.['user-agent']),
       },
       next,
     );

package/template/src/modules/request-context/request-context.module.ts

@@ -1,9 +1,9 @@
-import { Global, MiddlewareConsumer, Module, NestModule } from "@nestjs/common";
-import { APP_INTERCEPTOR } from "@nestjs/core";
-import { RequestContextService } from "./application/services/request-context.service";
-import { OrgScopeGuard } from "./presentation/org-scope.guard";
-import { RequestContextInterceptor } from "./presentation/request-context.interceptor";
-import { RequestContextMiddleware } from "./presentation/request-context.middleware";
+import { Global, MiddlewareConsumer, Module, NestModule } from '@nestjs/common';
+import { APP_INTERCEPTOR } from '@nestjs/core';
+import { RequestContextService } from './application/services/request-context.service';
+import { OrgScopeGuard } from './presentation/org-scope.guard';
+import { RequestContextInterceptor } from './presentation/request-context.interceptor';
+import { RequestContextMiddleware } from './presentation/request-context.middleware';
 
 @Global()
 @Module({
@@ -20,6 +20,6 @@ import { RequestContextMiddleware } from "./presentation/request-context.middlew
 })
 export class RequestContextModule implements NestModule {
   configure(consumer: MiddlewareConsumer) {
-    consumer.apply(RequestContextMiddleware).forRoutes("*");
+    consumer.apply(RequestContextMiddleware).forRoutes('*');
   }
 }

package/template/src/modules/request-context/types/request-context.ts

@@ -1,6 +1,6 @@
-import { RbacContext } from "../../access-control/types/rbac-context";
+import { RbacContext } from '../../access-control/types/rbac-context';
 
-export type RequestSource = "http" | "worker";
+export type RequestSource = 'http' | 'worker';
 
 export type RequestContext = {
   requestId: string;

package/template/src/modules/sample/application/services/sample.service.ts

@@ -1,9 +1,9 @@
-import { Injectable } from "@nestjs/common";
-import { Prisma } from "@prisma/client";
-import { PrismaService } from "../../../../database/prisma/prisma.service";
-import { AuthenticatedUser } from "../../../auth/types/authenticated-user";
-import { RequestContextService } from "../../../request-context/application/services/request-context.service";
-import { SampleEchoDto } from "../../dto/sample-echo.dto";
+import { Injectable } from '@nestjs/common';
+import { Prisma } from '@prisma/client';
+import { PrismaService } from '../../../../database/prisma/prisma.service';
+import { AuthenticatedUser } from '../../../auth/types/authenticated-user';
+import { RequestContextService } from '../../../request-context/application/services/request-context.service';
+import { SampleEchoDto } from '../../dto/sample-echo.dto';
 
 @Injectable()
 export class SampleService {
@@ -30,7 +30,7 @@ export class SampleService {
     await this.writeAudit({
       orgId,
       actorUserId: user.id,
-      action: "sample.echo",
+      action: 'sample.echo',
       targetId: orgId,
       metadata: {
         messageLength: message.length,
@@ -58,9 +58,11 @@ export class SampleService {
         orgId: data.orgId,
         actorUserId: data.actorUserId,
         action: data.action,
-        targetType: "Sample",
+        targetType: 'Sample',
         targetId: data.targetId,
         metadata: data.metadata,
+        ipAddress: this.requestContext.getIpAddress(),
+        userAgent: this.requestContext.getUserAgent(),
       },
     });
   }

package/template/src/modules/sample/dto/sample-echo.dto.ts

@@ -1,8 +1,8 @@
-import { ApiProperty } from "@nestjs/swagger";
-import { IsString, MaxLength, MinLength } from "class-validator";
+import { ApiProperty } from '@nestjs/swagger';
+import { IsString, MaxLength, MinLength } from 'class-validator';
 
 export class SampleEchoDto {
-  @ApiProperty({ example: "Hello from the sample module." })
+  @ApiProperty({ example: 'Hello from the sample module.' })
   @IsString()
   @MinLength(1)
   @MaxLength(200)

package/template/src/modules/sample/dto/sample-response.dto.ts

@@ -1,41 +1,41 @@
-import { ApiProperty } from "@nestjs/swagger";
+import { ApiProperty } from '@nestjs/swagger';
 
 export class SampleStatusResponseDto {
   @ApiProperty({ example: true })
   ok!: boolean;
 
   @ApiProperty({
-    example: "2c67399d-670c-4025-a5fd-1ea9a211891e",
-    format: "uuid",
+    example: '2c67399d-670c-4025-a5fd-1ea9a211891e',
+    format: 'uuid',
   })
   orgId!: string;
 
   @ApiProperty({
-    example: "2c67399d-670c-4025-a5fd-1ea9a211891e",
-    format: "uuid",
+    example: '2c67399d-670c-4025-a5fd-1ea9a211891e',
+    format: 'uuid',
   })
   contextOrgId!: string;
 
-  @ApiProperty({ example: "req_01HZX3J8TBMJAEK42S7XK4V7C8" })
+  @ApiProperty({ example: 'req_01HZX3J8TBMJAEK42S7XK4V7C8' })
   requestId!: string;
 }
 
 export class SampleEchoResponseDto {
   @ApiProperty({
-    example: "2c67399d-670c-4025-a5fd-1ea9a211891e",
-    format: "uuid",
+    example: '2c67399d-670c-4025-a5fd-1ea9a211891e',
+    format: 'uuid',
   })
   orgId!: string;
 
   @ApiProperty({
-    example: "2c67399d-670c-4025-a5fd-1ea9a211891e",
-    format: "uuid",
+    example: '2c67399d-670c-4025-a5fd-1ea9a211891e',
+    format: 'uuid',
   })
   contextOrgId!: string;
 
-  @ApiProperty({ example: "Hello from the sample module." })
+  @ApiProperty({ example: 'Hello from the sample module.' })
   message!: string;
 
-  @ApiProperty({ example: "req_01HZX3J8TBMJAEK42S7XK4V7C8" })
+  @ApiProperty({ example: 'req_01HZX3J8TBMJAEK42S7XK4V7C8' })
   requestId!: string;
 }