npm - @lenne.tech/nest-server - Versions diffs - 11.12.0 → 11.13.1 - Mend

@lenne.tech/nest-server 11.12.0 → 11.13.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (98) hide show

package/src/server/modules/better-auth/better-auth.resolver.ts CHANGED Viewed

@@ -1,9 +1,11 @@
+import { Optional } from '@nestjs/common';
 import { Args, Context, Mutation, Query, Resolver } from '@nestjs/graphql';
 import { Request, Response } from 'express';
 import { Roles } from '../../../core/common/decorators/roles.decorator';
 import { RoleEnum } from '../../../core/common/enums/role.enum';
 import { CoreBetterAuthAuthModel } from '../../../core/modules/better-auth/core-better-auth-auth.model';
+import { CoreBetterAuthEmailVerificationService } from '../../../core/modules/better-auth/core-better-auth-email-verification.service';
 import { CoreBetterAuthMigrationStatusModel } from '../../../core/modules/better-auth/core-better-auth-migration-status.model';
 import {
   CoreBetterAuth2FASetupModel,
@@ -12,6 +14,7 @@ import {
   CoreBetterAuthPasskeyModel,
   CoreBetterAuthSessionModel,
 } from '../../../core/modules/better-auth/core-better-auth-models';
+import { CoreBetterAuthSignUpValidatorService } from '../../../core/modules/better-auth/core-better-auth-signup-validator.service';
 import { CoreBetterAuthUserMapper } from '../../../core/modules/better-auth/core-better-auth-user.mapper';
 import { CoreBetterAuthResolver } from '../../../core/modules/better-auth/core-better-auth.resolver';
 import { CoreBetterAuthService } from '../../../core/modules/better-auth/core-better-auth.service';
@@ -29,8 +32,13 @@ import { CoreBetterAuthService } from '../../../core/modules/better-auth/core-be
  * @example
  * ```typescript
  * // Add custom behavior after sign-up
- * override async betterAuthSignUp(email: string, password: string, name?: string) {
- *   const result = await super.betterAuthSignUp(email, password, name);
+ * override async betterAuthSignUp(
+ *   email: string,
+ *   password: string,
+ *   name?: string,
+ *   termsAndPrivacyAccepted?: boolean,
+ * ) {
+ *   const result = await super.betterAuthSignUp(email, password, name, termsAndPrivacyAccepted);
  *
  *   if (result.success && result.user) {
  *     await this.emailService.sendWelcomeEmail(result.user.email);
@@ -46,8 +54,10 @@ export class BetterAuthResolver extends CoreBetterAuthResolver {
   constructor(
     protected override readonly betterAuthService: CoreBetterAuthService,
     protected override readonly userMapper: CoreBetterAuthUserMapper,
+    @Optional() protected override readonly signUpValidator?: CoreBetterAuthSignUpValidatorService,
+    @Optional() protected override readonly emailVerificationService?: CoreBetterAuthEmailVerificationService,
   ) {
-    super(betterAuthService, userMapper);
+    super(betterAuthService, userMapper, signUpValidator, emailVerificationService);
   }
   // ===========================================================================
@@ -112,7 +122,7 @@ export class BetterAuthResolver extends CoreBetterAuthResolver {
   override async betterAuthSignIn(
     @Args('email') email: string,
     @Args('password') password: string,
-    @Context() ctx: { req: Request; res: Response },
+    @Context() ctx?: { req: Request; res: Response },
   ): Promise<CoreBetterAuthAuthModel> {
     return super.betterAuthSignIn(email, password, ctx);
   }
@@ -125,8 +135,9 @@ export class BetterAuthResolver extends CoreBetterAuthResolver {
     @Args('email') email: string,
     @Args('password') password: string,
     @Args('name', { nullable: true }) name?: string,
+    @Args('termsAndPrivacyAccepted', { nullable: true }) termsAndPrivacyAccepted?: boolean,
   ): Promise<CoreBetterAuthAuthModel> {
-    return super.betterAuthSignUp(email, password, name);
+    return super.betterAuthSignUp(email, password, name, termsAndPrivacyAccepted);
   }
   @Mutation(() => Boolean, { description: 'Sign out via Better-Auth' })

package/src/templates/email-verification-de.ejs ADDED Viewed

@@ -0,0 +1,78 @@
+<!DOCTYPE html>
+<html lang="de">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>E-Mail-Adresse bestätigen</title>
+  <style>
+    body {
+      font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, sans-serif;
+      line-height: 1.6;
+      color: #333;
+      max-width: 600px;
+      margin: 0 auto;
+      padding: 20px;
+    }
+    .container {
+      background-color: #ffffff;
+      border-radius: 8px;
+      padding: 30px;
+      box-shadow: 0 2px 10px rgba(0,0,0,0.1);
+    }
+    h1 {
+      color: #2563eb;
+      margin-bottom: 20px;
+    }
+    .button {
+      display: inline-block;
+      background-color: #2563eb;
+      color: #ffffff !important;
+      text-decoration: none;
+      padding: 12px 30px;
+      border-radius: 6px;
+      font-weight: 600;
+      margin: 20px 0;
+    }
+    .button:hover {
+      background-color: #1d4ed8;
+    }
+    .footer {
+      margin-top: 30px;
+      padding-top: 20px;
+      border-top: 1px solid #e5e7eb;
+      font-size: 14px;
+      color: #6b7280;
+    }
+    .link-fallback {
+      font-size: 12px;
+      color: #6b7280;
+      word-break: break-all;
+      margin-top: 15px;
+    }
+  </style>
+</head>
+<body>
+  <div class="container">
+    <h1>Hallo <%= name %>,</h1>
+    <p>Vielen Dank für Ihre Registrierung bei <%= appName %>!</p>
+    <p>Bitte klicken Sie auf die Schaltfläche unten, um Ihre E-Mail-Adresse zu bestätigen:</p>
+    <p style="text-align: center;">
+      <a href="<%= link %>" class="button">E-Mail-Adresse bestätigen</a>
+    </p>
+    <p>Dieser Link ist <strong><%= expiresIn %></strong> gültig.</p>
+    <div class="footer">
+      <p>Wenn Sie kein Konto erstellt haben, können Sie diese E-Mail ignorieren.</p>
+      <p class="link-fallback">
+        Falls die Schaltfläche nicht funktioniert, kopieren Sie diesen Link in Ihren Browser:<br>
+        <a href="<%= link %>"><%= link %></a>
+      </p>
+    </div>
+  </div>
+</body>
+</html>

package/src/templates/email-verification-en.ejs ADDED Viewed

@@ -0,0 +1,78 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>Verify your email address</title>
+  <style>
+    body {
+      font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, sans-serif;
+      line-height: 1.6;
+      color: #333;
+      max-width: 600px;
+      margin: 0 auto;
+      padding: 20px;
+    }
+    .container {
+      background-color: #ffffff;
+      border-radius: 8px;
+      padding: 30px;
+      box-shadow: 0 2px 10px rgba(0,0,0,0.1);
+    }
+    h1 {
+      color: #2563eb;
+      margin-bottom: 20px;
+    }
+    .button {
+      display: inline-block;
+      background-color: #2563eb;
+      color: #ffffff !important;
+      text-decoration: none;
+      padding: 12px 30px;
+      border-radius: 6px;
+      font-weight: 600;
+      margin: 20px 0;
+    }
+    .button:hover {
+      background-color: #1d4ed8;
+    }
+    .footer {
+      margin-top: 30px;
+      padding-top: 20px;
+      border-top: 1px solid #e5e7eb;
+      font-size: 14px;
+      color: #6b7280;
+    }
+    .link-fallback {
+      font-size: 12px;
+      color: #6b7280;
+      word-break: break-all;
+      margin-top: 15px;
+    }
+  </style>
+</head>
+<body>
+  <div class="container">
+    <h1>Hello <%= name %>,</h1>
+    <p>Thank you for registering with <%= appName %>!</p>
+    <p>Please click the button below to verify your email address:</p>
+    <p style="text-align: center;">
+      <a href="<%= link %>" class="button">Verify Email Address</a>
+    </p>
+    <p>This link will expire in <strong><%= expiresIn %></strong>.</p>
+    <div class="footer">
+      <p>If you did not create an account, you can safely ignore this email.</p>
+      <p class="link-fallback">
+        If the button doesn't work, copy and paste this link into your browser:<br>
+        <a href="<%= link %>"><%= link %></a>
+      </p>
+    </div>
+  </div>
+</body>
+</html>

package/src/test/README.md ADDED Viewed

@@ -0,0 +1,190 @@
+# TestHelper Reference
+The `TestHelper` class provides utilities for testing GraphQL and REST APIs in `@lenne.tech/nest-server` projects.
+## Initialization
+```typescript
+import { TestHelper } from '@lenne.tech/nest-server';
+const app = moduleFixture.createNestApplication();
+await app.init();
+const testHelper = new TestHelper(app);
+// With WebSocket support for subscriptions
+const testHelper = new TestHelper(app, 'ws://127.0.0.1:3030/graphql');
+```
+## REST API Testing (`testHelper.rest()`)
+```typescript
+const result = await testHelper.rest('/endpoint', options);
+```
+### TestRestOptions
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `method` | `'GET' \| 'POST' \| 'PUT' \| 'PATCH' \| 'DELETE'` | `'GET'` | HTTP method |
+| `token` | `string` | `null` | Bearer token via Authorization header |
+| `cookies` | `string \| Record<string, string>` | - | Cookie-based authentication (see below) |
+| `headers` | `Record<string, string>` | - | Custom request headers |
+| `payload` | `any` | `null` | Request body |
+| `statusCode` | `number` | `200` | Expected HTTP status code |
+| `returnResponse` | `boolean` | `false` | Return full response including headers |
+| `attachments` | `Record<string, string>` | - | File uploads (key: field name, value: file path) |
+| `log` | `boolean` | `false` | Log request config to console |
+| `logError` | `boolean` | `false` | Log error details when status >= 400 |
+## Cookie Authentication
+The `cookies` option supports three modes with **auto-detection**:
+### 1. Plain Session Token (Auto-Detection)
+When a string **without** `=` or `;` is provided, it is automatically recognized as a session token and converted via `buildBetterAuthCookies()`:
+```typescript
+// Auto-detection: plain token -> sets iam.session_token + token cookies
+const result = await testHelper.rest('/endpoint', {
+  cookies: sessionToken,
+});
+```
+This is equivalent to:
+```typescript
+cookies: { 'iam.session_token': sessionToken, 'token': sessionToken }
+```
+### 2. Explicit Cookie Pairs
+```typescript
+const result = await testHelper.rest('/endpoint', {
+  cookies: { 'iam.session_token': token, 'custom-cookie': 'value' },
+});
+```
+### 3. Raw Cookie String
+When a string **with** `=` or `;` is provided, it is used as-is:
+```typescript
+const result = await testHelper.rest('/endpoint', {
+  cookies: 'iam.session_token=abc; token=xyz',
+});
+```
+### `token` vs `cookies`
+| Option | Transport | Use Case |
+|--------|-----------|----------|
+| `token` | `Authorization: Bearer <token>` header | JWT authentication |
+| `cookies` | `Cookie` header | Session-based authentication (BetterAuth) |
+Both can be used simultaneously without conflict - `token` sets the Authorization header while `cookies` sets the Cookie header.
+## Static Helper Methods
+### `TestHelper.buildBetterAuthCookies(sessionToken, basePath?)`
+Build a cookie Record for BetterAuth session authentication:
+```typescript
+const cookies = TestHelper.buildBetterAuthCookies('session-token-value');
+// Result: { 'iam.session_token': 'session-token-value', 'token': 'session-token-value' }
+// Custom base path
+const cookies = TestHelper.buildBetterAuthCookies('token', 'auth');
+// Result: { 'auth.session_token': 'token', 'token': 'token' }
+```
+### `TestHelper.extractSessionToken(response, cookieName?)`
+Extract a session token from Set-Cookie headers. Handles signed cookies (`value.signature` format):
+```typescript
+const response = await testHelper.rest('/iam/sign-in/email', {
+  method: 'POST',
+  payload: { email, password },
+  returnResponse: true,
+});
+const sessionToken = TestHelper.extractSessionToken(response);
+// Returns the token value from 'iam.session_token' cookie
+// Custom cookie name
+const token = TestHelper.extractSessionToken(response, 'custom.session_token');
+```
+### `TestHelper.extractCookies(response)`
+Extract all Set-Cookie values as a `Record<name, value>`:
+```typescript
+const response = await testHelper.rest('/iam/sign-in/email', {
+  method: 'POST',
+  payload: { email, password },
+  returnResponse: true,
+});
+const cookies = TestHelper.extractCookies(response);
+// Result: { 'iam.session_token': 'abc.sig', 'token': 'abc.sig', ... }
+```
+## Practical Examples
+### JWT Authentication
+```typescript
+const signIn = await testHelper.rest('/iam/sign-in/email', {
+  method: 'POST',
+  payload: { email: 'user@test.com', password: 'Password123!' },
+});
+const jwtToken = signIn.token;
+await testHelper.rest('/protected-endpoint', {
+  token: jwtToken,
+});
+```
+### Cookie Authentication (Auto-Detection)
+```typescript
+// Get session token from database after sign-in
+const session = await db.collection('session').findOne({ userId: user._id });
+// Use session token with auto-detection
+await testHelper.rest('/protected-endpoint', {
+  cookies: session.token,  // Auto -> iam.session_token=...; token=...
+});
+```
+### Extract Session Token from Response
+```typescript
+const response = await testHelper.rest('/iam/sign-in/email', {
+  method: 'POST',
+  payload: { email, password },
+  returnResponse: true,
+});
+const sessionToken = TestHelper.extractSessionToken(response);
+// Use extracted token for subsequent requests
+await testHelper.rest('/protected-endpoint', {
+  cookies: sessionToken,
+});
+```
+## GraphQL Testing (`testHelper.graphQl()`)
+```typescript
+const result = await testHelper.graphQl({
+  name: 'findUsers',
+  type: TestGraphQLType.QUERY,
+  arguments: { filter: { email: { eq: 'test@test.com' } } },
+  fields: ['id', 'email', 'name'],
+}, {
+  token: jwtToken,
+  statusCode: 200,
+});
+```
+See `TestGraphQLConfig` and `TestGraphQLOptions` interfaces in `test.helper.ts` for full configuration options.

package/src/test/test.helper.ts CHANGED Viewed

@@ -129,6 +129,17 @@ export interface TestGraphQLVariable {
  */
 export interface TestRestOptions {
   attachments?: Record<string, string>;
+  /**
+   * Cookies for the request. Three usage modes:
+   * - string (plain token without = or ;): Auto-detected as session token
+   *   and converted via buildBetterAuthCookies() to all relevant cookie names
+   *   (iam.session_token, token)
+   * - string (with = or ;): Used as-is as a cookie string
+   * - Record<string, string>: Key-value pairs joined into a cookie string
+   */
+  cookies?: Record<string, string> | string;
   headers?: Record<string, string>;
   log?: boolean;
   logError?: boolean;
@@ -404,10 +415,11 @@ export class TestHelper {
     };
     // Init vars
-    const { attachments, log, logError, returnResponse, statusCode, token } = config;
+    const { attachments, cookies, log, logError, returnResponse, statusCode, token } = config;
     // Request configuration
     const requestConfig: any = {
+      cookies,
       headers: config.headers,
       method: config.method,
       url,
@@ -560,6 +572,24 @@ export class TestHelper {
       request.set('Authorization', `bearer ${token}`);
     }
+    // Cookies
+    if (requestConfig.cookies) {
+      let cookieString: string;
+      if (typeof requestConfig.cookies === 'string') {
+        // Auto-detect: plain token (no = or ;) vs formatted cookie string
+        if (!requestConfig.cookies.includes('=') && !requestConfig.cookies.includes(';')) {
+          // Plain session token -> auto-build BetterAuth cookies
+          const cookieRecord = TestHelper.buildBetterAuthCookies(requestConfig.cookies);
+          cookieString = Object.entries(cookieRecord).map(([k, v]) => `${k}=${v}`).join('; ');
+        } else {
+          cookieString = requestConfig.cookies;
+        }
+      } else {
+        cookieString = Object.entries(requestConfig.cookies).map(([k, v]) => `${k}=${v}`).join('; ');
+      }
+      request.set('Cookie', cookieString);
+    }
     // Headers
     if (requestConfig.headers) {
       for (const [key, value] of Object.entries(requestConfig.headers)) {
@@ -724,6 +754,57 @@ export class TestHelper {
     return messages;
   }
+  /**
+   * Build a cookie Record for BetterAuth session authentication.
+   * Sets the token in all relevant cookie names for compatibility.
+   */
+  static buildBetterAuthCookies(sessionToken: string, basePath: string = 'iam'): Record<string, string> {
+    return {
+      [`${basePath}.session_token`]: sessionToken,
+      'token': sessionToken,
+    };
+  }
+  /**
+   * Extract all Set-Cookie values from a supertest response as a Record<name, value>.
+   */
+  static extractCookies(response: any): Record<string, string> {
+    const cookies: Record<string, string> = {};
+    const setCookieHeaders = response?.headers?.['set-cookie'];
+    if (!setCookieHeaders) {
+      return cookies;
+    }
+    const headerArray = Array.isArray(setCookieHeaders) ? setCookieHeaders : [setCookieHeaders];
+    for (const cookie of headerArray) {
+      const parts = cookie.split(';')[0];
+      const eqIndex = parts.indexOf('=');
+      if (eqIndex > 0) {
+        const name = parts.substring(0, eqIndex).trim();
+        const value = parts.substring(eqIndex + 1).trim();
+        cookies[name] = value;
+      }
+    }
+    return cookies;
+  }
+  /**
+   * Extract a session token from Set-Cookie headers of a supertest response.
+   * Handles signed cookies (value.signature format) by returning only the value part.
+   */
+  static extractSessionToken(response: any, cookieName: string = 'iam.session_token'): null | string {
+    const cookies = TestHelper.extractCookies(response);
+    const value = cookies[cookieName];
+    if (!value) {
+      return null;
+    }
+    // Handle signed cookies: value.signature -> return value
+    const dotIndex = value.lastIndexOf('.');
+    if (dotIndex > 0 && dotIndex < value.length - 1) {
+      return value.substring(0, dotIndex);
+    }
+    return value;
+  }
   /**
    * Convert JWT into to object
    * @param token