@solidxai/core 0.1.10-beta.15 → 0.1.10-beta.21

package/docs/seed-changes.md

@@ -0,0 +1,65 @@
+# Seeding Enhancements Summary
+
+## Overview
+This document summarizes the changes made to seeding behavior in `solid-core`:
+- Metadata pruning support across targets.
+- CLI flags for selective modules and pruning.
+
+## Pruning Support
+Pruning is now available for most metadata targets. When enabled, records present in the DB but missing from JSON are removed. This is done in two phases:
+1. Identify records in DB not present in JSON.
+2. Delete those records before normal upsert seeding.
+
+### Targets with Pruning
+- Module models + fields (with model-level pruning).
+- Views, actions, menus (with join cleanup).
+- Security rules, list of values, dashboards.
+- Scheduled jobs, saved filters, model sequences.
+- Permissions (also clears role-permission join table).
+
+### Targets WITHOUT Pruning (conservative)
+- Module metadata itself
+- Media storage providers
+- Roles
+- Users
+- Email templates
+- SMS templates
+- System fields (global)
+- Default settings (global)
+
+### Pruning Mode
+Pruning runs **only** when `--prune` is provided. If omitted, pruning is skipped.
+
+## CLI Changes
+### Modules to Seed
+`--conf` was removed. Use:
+```
+--modules-to-seed venue,reports
+```
+This passes `modulesToSeed` to the seeder as an array.
+
+## Sample Commands
+### Default seeding
+```
+npx @solidxai/solidctl seed
+```
+
+### Select modules only
+```
+npx @solidxai/solidctl seed --modules-to-seed venue,reports
+```
+
+### Pruning enabled
+```
+npx @solidxai/solidctl seed --modules-to-seed venue --prune
+```
+
+### Pruning enabled (all modules)
+```
+npx @solidxai/solidctl seed --prune
+```
+
+## Files Touched (Key)
+- `src/seeders/module-metadata-seeder.service.ts`
+- `src/commands/seed.command.ts`
+- `src/repository/solid-base.repository.ts` (added `findOneByUserKey`)

package/docs/test-data-workflow.md

@@ -0,0 +1,200 @@
+# Test Data Workflow
+
+This document describes the end-to-end workflow for creating isolated test databases, seeding metadata, loading test data, and tearing everything down.
+
+## Overview
+The workflow is designed to:
+- Create one **test database per configured datasource** in the project.
+- Point the app to those new databases via `.env` updates.
+- Seed all metadata into the fresh databases.
+- Load model-specific `testData` entries from module metadata JSON files.
+- Cleanly reverse everything at the end.
+
+The commands below are the canonical flow.
+
+---
+
+## Step 1: Create test datasources
+
+Command:
+```
+npx @solidxai/solidctl test data --setup
+```
+
+What this does:
+- Reads all configured datasources from the Solid registry (`SolidRegistry.getSolidDatabaseModules()`), and uses their `name()` values.
+- Generates a unique **run name** (two words, underscore-separated, e.g. `steady_wolf`).
+- Builds a **timestamped database name** per datasource:
+  - `<datasource>_<timestamp>_<runName>`
+- Backs up the current `.env` into `.env.backup.<runName>`.
+- Rewrites `.env` in-place with new `*_DATABASE_NAME` values.
+- Creates the databases/schemas using TypeORM and the configured connection info.
+- Writes a `.solidx-test-manifest` with the run name + database names so the teardown can reverse everything later.
+
+Example output:
+```
+▶ Running solid test data
+Creating test datasource environment file and manifest.
+Backed up .env to .env.backup.steady_wolf and applied new test datasource names to .env.
+Creating test database/schema "default_20260201234402_steady_wolf" on datasource "default"...
+
+============================================================
+  TEST DATASOURCE ENVIRONMENT CREATED
+------------------------------------------------------------
+  Run name : steady_wolf
+  Env backup : .env.backup.steady_wolf
+
+  Test databases/schemas created:
+- default: default_20260201234402_steady_wolf
+
+  Next steps:
+  1) Using updated .env with test datasource names
+  2) Run solid seed as usual
+  3) Proceed with loading the test data for each module
+  4) Run the test cases 
+  5) Tear down
+============================================================
+
+✔ solid test data completed
+```
+
+Rationale:
+- The `.env` rewrite guarantees the app connects to fresh databases without changing code.
+- The manifest records the run so deletion is safe and deterministic.
+
+---
+
+## Step 2: Seed metadata into the new databases
+
+Command:
+```
+npx @solidxai/solidctl seed
+```
+
+What this does:
+- Seeds full module metadata into the **fresh test databases**.
+- Generates the `sa` user if needed and prints its password.
+- Ensures all models, fields, roles, permissions, views, actions, etc. exist before loading test data.
+
+Example output (truncated):
+```
+▶ Running solid seed
+▶ Pruning disabled: existing metadata will be kept.
+▶ No modulesToSeed provided. Seeding ALL modules.
+▶ Seeding Metadata for Module: solid-core
+✔ [solid-core] Module/Model/Fields seeded (upserted 376)
+...
+✔ Seeding completed.
+✔ solid seed completed
+```
+
+Rationale:
+- Test data relies on model metadata and relationships; this ensures the schema and reference data are ready.
+
+---
+
+## Step 3: Load test data
+
+Command:
+```
+npx @solidxai/solidctl test data --load
+```
+
+What this does:
+- Reads all module metadata files (or a subset if `--modules-to-test` is provided).
+- Looks for `testData` arrays in each metadata file.
+- Resolves the correct repository for each model (repository name pattern: `<ModelName>Repository`).
+- Performs **upsert-style** inserts using the model’s `userKeyFieldUserKey`.
+- Resolves many-to-one relations using `${fieldName}UserKey`.
+
+Example output:
+```
+▶ Running solid test data
+Test data setup for all modules.
+Processing test data for module: solid-core
+✔ Test data setup complete for module: solid-core
+Processing test data for module: venue
+✔ Test data setup complete for module: venue
+✔ solid test data completed
+```
+
+Rationale:
+- This keeps test fixtures human-readable and tied to module metadata.
+
+---
+
+
+## Step 4: Run Tests 
+```
+npx @solidxai/solidctl test run --module venue --api-base-url http://localhost:3000 --ui-base-url http://localhost:5173 --headless false
+```
+
+```
+npx @solidxai/solidctl test run --module venue --list-specs
+```
+
+What this does:
+- Loads `testing.scenarios` from the module metadata file.
+- Applies `--scenario-ids` or `--include-tags` filtering if provided.
+- Boots API and UI adapters with the supplied base URLs.
+- Registers any custom test specs listed in `testing.specs`.
+- Executes scenarios in order with fail‑fast behavior.
+
+Useful variants:
+```
+npx @solidxai/solidctl test run --module venue --scenario-ids api-authenticate-success,api-create-states
+```
+
+```
+npx @solidxai/solidctl test run --module venue --include-tags smoke
+```
+
+```
+npx @solidxai/solidctl test run --module venue --api-base-url http://localhost:3000 --headless true
+```
+
+```
+npx @solidxai/solidctl test run --module venue --headless false
+```
+
+Notes:
+- If your scenario depends on a previous scenario’s `saveAs` output (e.g., `loginSuccess`), ensure the auth scenario runs first.
+- For UI tests, `--ui-base-url` should point to a running frontend server.
+- `--list-specs` prints registered custom `test.spec` ids and exits.
+
+
+## Step 5: Tear everything down
+
+Command:
+```
+npx @solidxai/solidctl test data --teardown
+```
+
+What this does:
+- Restores `.env` from the latest `.env.backup.<runName>`.
+- Deletes all `.env.backup.<runName>` files created by the workflow.
+- Drops each test database/schema recorded in `.solidx-test-manifest`.
+- Deletes the manifest file.
+
+Example output:
+```
+▶ Running solid test data
+Deleting test datasource environment and databases.
+Dropping test database/schema "default_20260201234402_steady_wolf" on datasource "default"...
+✔ Test datasource env files and manifest deleted; test databases dropped.
+✔ solid test data completed
+```
+
+Rationale:
+- Keeps the local environment clean and restores the original `.env` safely.
+
+---
+
+## Optional: Limit modules for test data load
+
+You can restrict test data loading to a subset of modules:
+```
+npx @solidxai/solidctl test data --load --modules-to-test venue,reports
+```
+
+Only the listed modules are processed.

package/docs/type-declaration-import-issue.md

@@ -0,0 +1,24 @@
+# Issue: Consumer sees `Property 'id' does not exist on type 'VenueUser'`
+
+## Summary
+The published declaration files in `dist/` import internal types using `src/...` module specifiers. In a consuming project, TypeScript resolves those imports against the consumer's `src` path (or fails), which can cause `User` to extend a different `CommonEntity` that does not define `id`. This leads to `Property 'id' does not exist on type 'VenueUser'` even though `CommonEntity` in the library defines it.
+
+## Evidence
+- `dist/entities/user.entity.d.ts` starts with:
+  - `import { CommonEntity } from "src/entities/common.entity";`
+- `dist/entities/common.entity.d.ts` correctly contains:
+  - `id: number;`
+
+Because the import is `src/...`, the consumer may resolve it to their own `src` tree instead of the library's `dist` types.
+
+## Root Cause
+Library declarations are not portable because internal imports are using absolute `src/...` aliases. These aliases are not part of Node module resolution, so consumers resolve them differently.
+
+## Fix Options
+1. **Preferred:** Replace internal imports in `src/` with relative paths so emitted `.d.ts` files are portable.
+2. **Alternative:** Keep `src/*` aliases but add a post-build step (e.g., `tsc-alias`) to rewrite `dist/**/*.d.ts` imports to relative paths.
+
+## Next Steps
+- Decide on option 1 or 2.
+- Rebuild and verify `dist/**/*.d.ts` no longer import from `src/...`.
+- Publish a new package version and ensure the consuming app resolves `User` and `CommonEntity` from the same package instance.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solidxai/core",
-  "version": "0.1.10-beta.15",
+  "version": "0.1.10-beta.21",
   "description": "This module is a NestJS module containing all the required core providers required by a Solid application",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/commands/test-data.command.ts

@@ -7,6 +7,7 @@ interface TestDataCommandOptions {
   modulesToTest?: string;
   setup?: boolean;
   teardown?: boolean;
+  unlink?: boolean;
 }
 
 @SubCommand({
@@ -25,17 +26,18 @@ export class TestDataCommand extends CommandRunner {
       const load = Boolean(options?.load);
       const setup = Boolean(options?.setup);
       const teardown = Boolean(options?.teardown);
+      const unlink = Boolean(options?.unlink);
 
-      const selectedModes = [load, setup, teardown].filter(Boolean).length;
+      const selectedModes = [load, setup, teardown, unlink].filter(Boolean).length;
       if (selectedModes > 1) {
-        this.logger.error('Please specify only one of --load, --setup, or --teardown.');
-        console.log('Please specify only one of --load, --setup, or --teardown.');
+        this.logger.error('Please specify only one of --load, --setup, --teardown, or --unlink.');
+        console.log('Please specify only one of --load, --setup, --teardown, or --unlink.');
         return;
       }
 
-      if (!load && !setup && !teardown) {
-        this.logger.error('Please specify one of --load, --setup, or --teardown.');
-        console.log('Please specify one of --load, --setup, or --teardown.');
+      if (!load && !setup && !teardown && !unlink) {
+        this.logger.error('Please specify one of --load, --setup, --teardown, or --unlink.');
+        console.log('Please specify one of --load, --setup, --teardown, or --unlink.');
         return;
       }
 
@@ -65,6 +67,19 @@ export class TestDataCommand extends CommandRunner {
         await this.testDataService.setupTestData(modulesToTest ?? undefined);
         return;
       }
+
+      if (unlink) {
+        const modulesToTest = options?.modulesToTest ? options.modulesToTest.split(',').map((m) => m.trim()).filter(Boolean) : null;
+        if (modulesToTest?.length) {
+          this.logger.log(`Test data unlink for modules: ${modulesToTest.join(', ')}`);
+          console.log(`Test data unlink for modules: ${modulesToTest.join(', ')}`);
+        } else {
+          this.logger.log('Test data unlink for all modules.');
+          console.log('Test data unlink for all modules.');
+        }
+        await this.testDataService.removeTestData(modulesToTest ?? undefined);
+        return;
+      }
     } catch (err: any) {
       const message = err?.message ?? String(err);
       this.logger.error(message);
@@ -109,4 +124,12 @@ export class TestDataCommand extends CommandRunner {
     return val;
   }
 
+  @Option({
+    flags: '--unlink',
+    description: 'Delete test data from testing.data sections in reverse order',
+  })
+  parseUnlink(): boolean {
+    return true;
+  }
+
 }

package/src/controllers/chatter-message.controller.ts

@@ -5,6 +5,7 @@ import { ChatterMessageService } from '../services/chatter-message.service';
 import { CreateChatterMessageDto } from '../dtos/create-chatter-message.dto';
 import { UpdateChatterMessageDto } from '../dtos/update-chatter-message.dto';
 import { PostChatterMessageDto } from '../dtos/post-chatter-message.dto';
+import { UpdateChatterNoteMessageDto } from '../dtos/update-chatter-note-message.dto';
 import { SolidRequestContextDecorator } from 'src/decorators/solid-request-context.decorator';
 import { SolidRequestContextDto } from 'src/dtos/solid-request-context.dto';
 import { Public } from 'src/decorators/public.decorator';
@@ -127,4 +128,15 @@ export class ChatterMessageController {
   async markCompleted(@Param('id') id: string) {
     return this.service.markCompleted(+id);
   }
+
+  @ApiBearerAuth("jwt")
+  @Patch(':id/note')
+  @UseInterceptors(AnyFilesInterceptor())
+  async updateCustomNoteMessage(
+    @Param('id') id: string,
+    @Body() updateDto: UpdateChatterNoteMessageDto,
+    @UploadedFiles() files: Array<Express.Multer.File>,
+  ) {
+    return this.service.updateCustomNoteMessage(+id, updateDto, files);
+  }
 }

package/src/controllers/gupshup-webhook.controller.ts

@@ -0,0 +1,91 @@
+import {
+  Body,
+  Controller,
+  HttpCode,
+  HttpStatus,
+  Logger,
+  Post,
+  Req,
+} from "@nestjs/common";
+import { ApiTags } from "@nestjs/swagger";
+import { Request } from "express";
+import { Auth } from "src/decorators/auth.decorator";
+import { Public } from "src/decorators/public.decorator";
+import { AuthType } from "src/enums/auth-type.enum";
+
+@Auth(AuthType.None)
+@Controller("webhook/whatsapp/gupshup")
+@ApiTags("Solid Core")
+export class GupshupWebhookController {
+  private readonly logger = new Logger(GupshupWebhookController.name);
+
+  @Public()
+  @Post()
+  @HttpCode(HttpStatus.OK)
+  async receiveWebhook(@Req() req: Request, @Body() body: unknown) {
+    const userAgent = req.headers["user-agent"] ?? null;
+    this.logger.log(
+      `Received Gupshup WhatsApp webhook${userAgent ? ` from ${userAgent}` : ""}`,
+    );
+    this.logger.debug(`Gupshup webhook payload: ${JSON.stringify(body)}`);
+
+    const statusInfo = this.extractStatusInfo(body);
+    if (statusInfo) {
+      this.logger.log(
+        `Gupshup delivery update: status=${statusInfo.status ?? "unknown"}, messageId=${statusInfo.messageId ?? "n/a"}, destination=${statusInfo.destination ?? "n/a"}, reason=${statusInfo.reason ?? "n/a"}`,
+      );
+    }
+
+    return {
+      success: true,
+      message: "Webhook received",
+    };
+  }
+
+  private extractStatusInfo(body: unknown): {
+    status?: string;
+    messageId?: string;
+    destination?: string;
+    reason?: string;
+  } | null {
+    if (!body || typeof body !== "object") {
+      return null;
+    }
+
+    const payload = body as Record<string, unknown>;
+
+    const status =
+      this.asString(payload.status) ||
+      this.asString(payload.messageStatus) ||
+      this.asString((payload.payload as Record<string, unknown>)?.status) ||
+      this.asString((payload.payload as Record<string, unknown>)?.type);
+
+    const messageId =
+      this.asString(payload.messageId) ||
+      this.asString(payload.id) ||
+      this.asString((payload.payload as Record<string, unknown>)?.id) ||
+      this.asString((payload.payload as Record<string, unknown>)?.messageId);
+
+    const destination =
+      this.asString(payload.destination) ||
+      this.asString(payload.phone) ||
+      this.asString((payload.payload as Record<string, unknown>)?.destination) ||
+      this.asString((payload.payload as Record<string, unknown>)?.phone);
+
+    const reason =
+      this.asString(payload.reason) ||
+      this.asString(payload.error) ||
+      this.asString((payload.payload as Record<string, unknown>)?.reason) ||
+      this.asString((payload.payload as Record<string, unknown>)?.error);
+
+    if (!status && !messageId && !destination && !reason) {
+      return null;
+    }
+
+    return { status, messageId, destination, reason };
+  }
+
+  private asString(value: unknown): string | undefined {
+    return typeof value === "string" && value.trim() ? value.trim() : undefined;
+  }
+}

package/src/controllers/meta-cloud-whatsapp-webhook.controller.ts

@@ -0,0 +1,155 @@
+import {
+  Body,
+  Controller,
+  Get,
+  HttpCode,
+  HttpStatus,
+  Logger,
+  Post,
+  Query,
+  Res,
+} from "@nestjs/common";
+import { ApiTags } from "@nestjs/swagger";
+import { Response } from "express";
+import { Auth } from "src/decorators/auth.decorator";
+import { Public } from "src/decorators/public.decorator";
+import { AuthType } from "src/enums/auth-type.enum";
+import { SettingService } from "src/services/setting.service";
+import type { SolidCoreSetting } from "src/services/settings/default-settings-provider.service";
+
+@Auth(AuthType.None)
+@Controller("webhook/whatsapp/meta-cloud")
+@ApiTags("Solid Core")
+export class MetaCloudWhatsappWebhookController {
+  private readonly logger = new Logger(MetaCloudWhatsappWebhookController.name);
+
+  constructor(private readonly settingService: SettingService) {}
+
+  @Public()
+  @Get()
+  verifyWebhook(@Query() query: Record<string, unknown>, @Res() res: Response) {
+    const mode = this.resolveQueryValue(query, "hub.mode", "hub_mode", "mode");
+    const verifyToken = this.resolveQueryValue(
+      query,
+      "hub.verify_token",
+      "hub_verify_token",
+      "verify_token",
+    );
+    const challenge = this.resolveQueryValue(
+      query,
+      "hub.challenge",
+      "hub_challenge",
+      "challenge",
+    );
+
+    const configuredVerifyToken =
+      this.settingService.getConfigValue<SolidCoreSetting>(
+        "metaWhatsappWebhookVerifyToken",
+      ) || process.env.COMMON_META_WHATSAPP_WEBHOOK_VERIFY_TOKEN;
+
+    const isVerificationCall = mode === "subscribe";
+    const tokenMatches =
+      !!configuredVerifyToken && verifyToken === configuredVerifyToken;
+
+    if (isVerificationCall && tokenMatches && challenge) {
+      this.logger.log("Meta Cloud WhatsApp webhook verified successfully.");
+      res.writeHead(HttpStatus.OK, {
+        "Content-Type": "text/plain",
+        "Content-Length": Buffer.byteLength(String(challenge)),
+      });
+      res.write(String(challenge));
+      return res.end();
+    }
+
+    this.logger.warn(
+      `Meta Cloud webhook verification failed. mode=${mode ?? "n/a"}, tokenMatch=${tokenMatches}`,
+    );
+
+    res.writeHead(HttpStatus.FORBIDDEN, { "Content-Type": "text/plain" });
+    return res.end("Webhook verification failed");
+  }
+
+  @Public()
+  @Post()
+  @HttpCode(HttpStatus.OK)
+  async receiveWebhook(@Body() body: unknown) {
+    this.logger.log("Received Meta Cloud WhatsApp webhook");
+    this.logger.debug(`Meta Cloud webhook payload: ${JSON.stringify(body)}`);
+
+    const statusInfo = this.extractStatusInfo(body);
+    if (statusInfo) {
+      this.logger.log(
+        `Meta Cloud delivery update: status=${statusInfo.status ?? "unknown"}, messageId=${statusInfo.messageId ?? "n/a"}, destination=${statusInfo.destination ?? "n/a"}, reason=${statusInfo.reason ?? "n/a"}`,
+      );
+    }
+
+    return {
+      success: true,
+      message: "Webhook received",
+    };
+  }
+
+  private extractStatusInfo(body: unknown): {
+    status?: string;
+    messageId?: string;
+    destination?: string;
+    reason?: string;
+  } | null {
+    if (!body || typeof body !== "object") {
+      return null;
+    }
+
+    const payload = body as Record<string, unknown>;
+    const entries = payload.entry as Array<Record<string, unknown>> | undefined;
+    const changes = entries?.[0]?.changes as Array<Record<string, unknown>> | undefined;
+    const value = changes?.[0]?.value as Record<string, unknown> | undefined;
+    const statuses = value?.statuses as Array<Record<string, unknown>> | undefined;
+    const status = statuses?.[0];
+
+    if (!status) {
+      return null;
+    }
+
+    const errors = status.errors as Array<Record<string, unknown>> | undefined;
+
+    return {
+      status: this.asString(status.status),
+      messageId: this.asString(status.id),
+      destination: this.asString(status.recipient_id),
+      reason:
+        this.asString(errors?.[0]?.title) || this.asString(errors?.[0]?.message),
+    };
+  }
+
+  private asString(value: unknown): string | undefined {
+    return typeof value === "string" && value.trim() ? value.trim() : undefined;
+  }
+
+  private resolveQueryValue(
+    query: Record<string, unknown>,
+    ...keys: string[]
+  ): string | undefined {
+    for (const key of keys) {
+      const directValue = this.asString(query[key]);
+      if (directValue) {
+        return directValue;
+      }
+    }
+
+    const hubRaw = query.hub;
+    if (hubRaw && typeof hubRaw === "object" && !Array.isArray(hubRaw)) {
+      const hub = hubRaw as Record<string, unknown>;
+      for (const key of ["mode", "verify_token", "challenge"]) {
+        const value = this.asString(hub[key]);
+        if (
+          value &&
+          keys.some((candidate) => candidate.endsWith(key) || candidate === key)
+        ) {
+          return value;
+        }
+      }
+    }
+
+    return undefined;
+  }
+}

package/src/dtos/update-chatter-note-message.dto.ts

@@ -0,0 +1,14 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsNotEmpty, IsOptional, IsString } from 'class-validator';
+
+export class UpdateChatterNoteMessageDto {
+    @IsString()
+    @IsOptional()
+    @ApiProperty()
+    messageBody: string;
+
+    @IsString()
+    @IsOptional()
+    @ApiProperty({ required: false, description: 'Comma-separated media IDs to remove from this note.' })
+    removeAttachmentIds?: string;
+}