@solidxai/core 0.1.10-beta.2 → 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.2",
+  "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",
@@ -79,13 +79,10 @@
     "ts-morph": "^27.0.2",
     "twilio": "^5.8.0",
     "uuid": "^9.0.1",
-    "xlsx": "^0.18.5"
-  },
-  "peerDependenciesMeta": {
-    "playwright": {
-      "optional": true
-    }
+    "xlsx": "^0.18.5",
+    "playwright": ">=1.0.0"
   },
+  "peerDependenciesMeta": {},
   "peerDependencies": {
     "@nestjs/axios": "^3.0.2",
     "@nestjs/cache-manager": "^2.2.2",
@@ -98,13 +95,14 @@
     "@nestjs/mongoose": "^10.0.10",
     "@nestjs/passport": "^10.0.3",
     "@nestjs/platform-express": "^10.0.0",
+    "@nestjs/platform-ws": "^10.0.0",
     "@nestjs/serve-static": "^4.0.2",
     "@nestjs/swagger": "^7.2.0",
     "@nestjs/typeorm": "^10.0.1",
+    "@nestjs/websockets": "^10.0.0",
     "nest-commander": "^3.12.5",
     "nest-winston": "^1.9.7",
     "nestjs-cls": "^5.4.3",
-    "playwright": ">=1.0.0",
     "reflect-metadata": "^0.2.2",
     "typeorm": "^0.3.20",
     "typeorm-naming-strategies": "^4.1.0",
@@ -125,10 +123,12 @@
     "@nestjs/mongoose": "^10.0.10",
     "@nestjs/passport": "^10.0.3",
     "@nestjs/platform-express": "^10.0.0",
+    "@nestjs/platform-ws": "^10.0.0",
     "@nestjs/serve-static": "^4.0.2",
     "@nestjs/swagger": "^7.2.0",
     "@nestjs/testing": "^10.0.0",
     "@nestjs/typeorm": "^10.0.1",
+    "@nestjs/websockets": "^10.0.0",
     "@solidxai/code-builder": "^0.0.2",
     "@types/express": "^4.17.17",
     "@types/hapi__joi": "^17.1.12",

package/src/commands/refresh-model.command.ts

@@ -1,14 +1,10 @@
-import { BadRequestException, forwardRef, Inject, Logger } from '@nestjs/common';
+import { forwardRef, Inject, Logger } from '@nestjs/common';
 import { Command, CommandRunner, Option } from 'nest-commander';
 import { ModelMetadataService } from 'src/services/model-metadata.service';
 import { CommandError } from './helper';
-import { In } from 'typeorm';
 
 interface CommandOptions {
-  name?: string;
-  id?: number;
-  fieldIds?: number[];
-  fieldNames?: string[];
+  name: string;
   dryRun?: boolean;
 }
 
@@ -33,34 +29,20 @@ export class RefreshModelCommand extends CommandRunner {
     }
 
     const codeGenerationOptions = {
-      modelId: options.id,
       modelUserKey: options.name,
       dryRun: options.dryRun,
-      fieldIdsForRefresh: options.fieldIds,
-      fieldNamesForRefresh: options.fieldNames,
     };
     await this.modelMetadataService.handleGenerateCode(codeGenerationOptions);
   }
 
-  // Accept the model ID as an argument
   @Option({
-    flags: '-i, --id [model ID]',
-    description: 'Model ID from the ss_model_metadata table',
-  })
-  parseId(val: string): number {
-    return +val;
-  }
-
-  // Accept the module name as an argument
-  @Option({
-    flags: '-n, --name [model name]',
-    description: 'Model Name from the ss_model_metadata table',
+    flags: '-n, --name <model name>',
+    description: 'Model name (singularName) from the ss_model_metadata table',
   })
   parseName(val: string): string {
     return val;
   }
 
-  // Accept dry run as an argument
   @Option({
     flags: '-d, --dryRun [dry run]',
     description: 'Dry run the command',
@@ -70,36 +52,9 @@ export class RefreshModelCommand extends CommandRunner {
     return (val === 'false') ? false : true;
   }
 
-  // Accept field IDs as an argument
-  @Option({
-    flags: '-fids, --fieldIds [Array of field IDs]',
-    description: 'Json array of Field IDs from the ss_field_metadata table',
-  })
-  parseFieldIds(val: string): number[] {
-    //Check if the value is a json array
-    if (!val.startsWith('[') || !val.endsWith(']')) {
-      throw new BadRequestException('Field IDs should be a json array');
-    }
-    return JSON.parse(val).map((id: string) => parseInt(id));
-  }
-
-  // Accept field Names as an argument
-  @Option({
-    flags: '-fnames, --fieldNames [Array of field Names]',
-    description: 'Json array of Field Names from the ss_field_metadata table',
-  })
-  parseFieldNames(val: string): string[] {
-    //Check if the value is a json array
-    if (!val.startsWith('[') || !val.endsWith(']')) {
-      throw new BadRequestException('Field Names should be a json array');
-    }
-    return JSON.parse(val).map((name: string) => name.toString());
-  }
-
-  // Validate the options passed
   private validate(options: CommandOptions): CommandError[] {
-    if (!options.id && !options.name) {
-      return [new CommandError('Model ID or Model Name is required')];
+    if (!options.name) {
+      return [new CommandError('Model Name is required')];
     }
     return [];
   }

package/src/commands/refresh-module.command.ts

@@ -4,7 +4,6 @@ import { ModuleMetadataService } from '../services/module-metadata.service';
 import { CommandError } from './helper';
 
 interface CommandOptions {
-  id: number;
   name: string;
   dryRun: boolean;
 }
@@ -28,7 +27,6 @@ export class RefreshModuleCommand extends CommandRunner {
       return;
     }
     const codeGenerationOptions = {
-      moduleId: options.id,
       moduleUserKey: options.name,
       dryRun: options.dryRun,
     };
@@ -36,16 +34,7 @@ export class RefreshModuleCommand extends CommandRunner {
   }
 
   @Option({
-    flags: '-i, --id [module ID]',
-    description: 'Module ID from the ss_module_metadata table',
-  })
-  parseId(val: string): number {
-    return +val;
-  }
-
-  // Accept the module name as an argument
-  @Option({
-    flags: '-n, --name [module name]',
+    flags: '-n, --name <module name>',
     description: 'Module Name from the ss_module_metadata table',
   })
   parseName(val: string): string {
@@ -61,11 +50,9 @@ export class RefreshModuleCommand extends CommandRunner {
     return (val === 'false') ? false : true;
   }
 
-
-  // Validate the options passed
   validate(options: CommandOptions): CommandError[] {
-    if (!options.id && !options.name) {
-      return [new CommandError('Module ID or Module Name is required')];
+    if (!options.name) {
+      return [new CommandError('Module Name is required')];
     }
     return [];
   }

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/action-metadata.controller.ts

@@ -7,7 +7,7 @@ import { UpdateActionMetadataDto } from '../dtos/update-action-metadata.dto';
 import { SolidRequestContextDto } from 'src/dtos/solid-request-context.dto';
 import { SolidRequestContextDecorator } from 'src/decorators/solid-request-context.decorator';
 
-@ApiTags('App Builder')
+@ApiTags('Solid Core')
 @Controller('action-metadata') //FIXME: Change this to the model plural name 
 export class ActionMetadataController {
   constructor(private readonly service: ActionMetadataService) { }

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/facebook-authentication.controller.ts

@@ -24,7 +24,7 @@ import { UserService } from "../services/user.service";
 import type { SolidCoreSetting } from "../services/settings/default-settings-provider.service";
 
 @Auth(AuthType.None)
-@ApiTags("Iam")
+@ApiTags("Solid Core")
 @Controller("iam/facebook")
 export class FacebookAuthenticationController {
   constructor(

package/src/controllers/google-authentication.controller.ts

@@ -16,7 +16,7 @@ import type { SolidCoreSetting } from "src/services/settings/default-settings-pr
 
 @Auth(AuthType.None)
 @Controller('iam/google')
-@ApiTags("Iam")
+@ApiTags("Solid Core")
 // @UseGuards(ThrottlerGuard)
 // @SkipThrottle({ login: false, short: false, burst: true, sustained: true }) //Enable the login throttle only 
 export class GoogleAuthenticationController {