@solidxai/core 0.1.10-beta.3 → 0.1.10-beta.4

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.3",
+  "version": "0.1.10-beta.4",
   "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/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/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 {

package/src/controllers/menu-item-metadata.controller.ts

@@ -9,7 +9,7 @@ import { ActiveUserData } from 'src/interfaces/active-user-data.interface';
 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('menu-item-metadata') //FIXME: Change this to the model plural name 
 export class MenuItemMetadataController {
   constructor(private readonly service: MenuItemMetadataService) { }

package/src/controllers/microsoft-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/microsoft")
 export class MicrosoftAuthenticationController {
   constructor(

package/src/controllers/mq-message-queue.controller.ts

@@ -7,7 +7,7 @@ import { MqMessageQueueService } from '../services/mq-message-queue.service';
 import { SolidRequestContextDto } from 'src/dtos/solid-request-context.dto';
 import { SolidRequestContextDecorator } from 'src/decorators/solid-request-context.decorator';
 
-@ApiTags('Queues')
+@ApiTags('Solid Core')
 @Controller('mq-message-queue') //FIXME: Change this to the model plural name 
 export class MqMessageQueueController {
   constructor(protected readonly service: MqMessageQueueService) { }

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

@@ -7,7 +7,7 @@ import { AnyFilesInterceptor } from '@nestjs/platform-express';
 import { SolidRequestContextDecorator } from 'src/decorators/solid-request-context.decorator';
 import { SolidRequestContextDto } from 'src/dtos/solid-request-context.dto';
 
-@ApiTags('Queues')
+@ApiTags('Solid Core')
 @Controller('mq-message') //FIXME: Change this to the model plural name 
 export class MqMessageController {
   constructor(protected readonly service: MqMessageService) { }

package/src/controllers/view-metadata.controller.ts

@@ -9,7 +9,7 @@ import { SolidRequestContextDto } from 'src/dtos/solid-request-context.dto';
 import { ActiveUser } from 'src/decorators/active-user.decorator';
 import { ActiveUserData } from 'src/interfaces/active-user-data.interface';
 
-@ApiTags('App Builder')
+@ApiTags('Solid Core')
 @Controller('view-metadata') //FIXME: Change this to the model plural name 
 export class ViewMetadataController {
   constructor(private readonly service: ViewMetadataService) { }

package/src/entities/chatter-message-details.entity.ts

@@ -18,7 +18,6 @@ export class ChatterMessageDetails extends CommonEntity {
     @Column({ type: "varchar", nullable: true })
     oldValueDisplay: string;
 
-    @Index()
     @Column({ type: "varchar", nullable: true })
     newValueDisplay: string;
 
@@ -30,4 +29,4 @@ export class ChatterMessageDetails extends CommonEntity {
 
     @Column({ type: "varchar", nullable: true })
     fieldType: string;
-}
+}

package/src/helpers/field-crud-managers/BigIntFieldCrudManager.ts

@@ -20,7 +20,7 @@ export class BigIntFieldCrudManager implements FieldCrudManager {
                 if (typeof fieldValue === 'string' || typeof fieldValue === 'number') {
                     fieldValue = BigInt(fieldValue);
                 }
-            } catch (err) {
+            } catch (err: any) {
                 return [{ field: this.options.fieldName, error: 'Invalid numeric value' }];
             }
         }

package/src/helpers/field-crud-managers/SelectionDynamicFieldCrudManager.ts

@@ -119,7 +119,7 @@ export class SelectionDynamicFieldCrudManager implements FieldCrudManager {
             }
             return false;
         }
-        catch (error) {
+        catch (error: any) {
             // Use the values method as a fallback, if the value method is not implemented
             const values = await providerInstance.values('', ctxt);
             const isValid = values.some(v => v.value === fieldValue);

package/src/helpers/module-metadata-helper.service.ts

@@ -23,7 +23,7 @@ export class ModuleMetadataHelperService {
             const fileContent = await fs.readFile(configFilePath, 'utf8');
             return JSON.parse(fileContent);
         }
-        catch (error) {
+        catch (error: any) {
             this.logger.error(`module metadata configuration non existent at: ${configFilePath}`);
         }
 

package/src/jobs/database/chatter-queue-subscriber-database.service.ts

@@ -35,7 +35,7 @@ export class ChatterQueueSubscriberDatabase extends DatabaseSubscriber<AuditQueu
 
         switch (p.eventType) {
             case 'insert':
-                await this.chatterMessageService.postAuditMessageOnInsert(p.after, p.modelName);
+                await this.chatterMessageService.postAuditMessageOnInsert(p.after, p.modelName, false, p.userId);
                 break;
             case 'update':
                 await this.chatterMessageService.postAuditMessageOnUpdate(
@@ -43,10 +43,12 @@ export class ChatterQueueSubscriberDatabase extends DatabaseSubscriber<AuditQueu
                     p.modelName,
                     p.before,
                     (p.updatedColumnNames ?? []).map(n => ({ propertyName: n })),
+                    false,
+                    p.userId,
                 );
                 break;
             case 'delete':
-                await this.chatterMessageService.postAuditMessageOnDelete(p.modelName, p.before);
+                await this.chatterMessageService.postAuditMessageOnDelete(p.modelName, p.before, false, p.userId);
                 break;
         }
     }

package/src/jobs/database/trigger-mcp-client-subscriber-database.service.ts

@@ -60,7 +60,7 @@ export class TriggerMcpClientSubscriberDatabase extends DatabaseSubscriber<Trigg
                 // Fallback
                 nestedResponse = String(raw);
             }
-        } catch (err) {
+        } catch (err: any) {
             this.triggerMcpClientSubscriberLogger.error("Error processing AI response:", err);
             nestedResponse = `Error handling response: ${err?.message || String(err)}`;
         }

package/src/jobs/rabbitmq/chatter-queue-subscriber.service.ts

@@ -33,7 +33,7 @@ export class ChatterQueueSubscriberRabbitmq extends RabbitMqSubscriber<AuditQueu
 
         switch (p.eventType) {
             case 'insert':
-                await this.chatterMessageService.postAuditMessageOnInsert(p.after, p.modelName);
+                await this.chatterMessageService.postAuditMessageOnInsert(p.after, p.modelName, false, p.userId);
                 break;
             case 'update':
                 await this.chatterMessageService.postAuditMessageOnUpdate(
@@ -41,10 +41,12 @@ export class ChatterQueueSubscriberRabbitmq extends RabbitMqSubscriber<AuditQueu
                     p.modelName,
                     p.before,
                     (p.updatedColumnNames ?? []).map(n => ({ propertyName: n })),
+                    false,
+                    p.userId,
                 );
                 break;
             case 'delete':
-                await this.chatterMessageService.postAuditMessageOnDelete(p.modelName, p.before);
+                await this.chatterMessageService.postAuditMessageOnDelete(p.modelName, p.before, false, p.userId);
                 break;
         }
     }

package/src/jobs/redis/chatter-queue-subscriber-redis.service.ts

@@ -33,13 +33,20 @@ export class ChatterQueueSubscriberRedis extends RedisSubscriber<any> {
 
         switch (p.eventType) {
             case 'insert':
-                await this.chatterMessageService.postAuditMessageOnInsert(p.after, { name: p.modelName } as any);
+                await this.chatterMessageService.postAuditMessageOnInsert(p.after, p.modelName, false, p.userId);
                 break;
             case 'update':
-                await this.chatterMessageService.postAuditMessageOnUpdate(p.after, { name: p.modelName } as any, p.before, (p.updatedColumnNames || []).map(n => ({ propertyName: n })));
+                await this.chatterMessageService.postAuditMessageOnUpdate(
+                    p.after,
+                    p.modelName,
+                    p.before,
+                    (p.updatedColumnNames || []).map(n => ({ propertyName: n })),
+                    false,
+                    p.userId,
+                );
                 break;
             case 'delete':
-                await this.chatterMessageService.postAuditMessageOnDelete(p.before, { name: p.modelName } as any, p.before);
+                await this.chatterMessageService.postAuditMessageOnDelete(p.modelName, p.before, false, p.userId);
                 break;
         }
     }

package/src/repository/security-rule.repository.ts

@@ -56,7 +56,7 @@ export class SecurityRuleRepository extends SolidBaseRepository<SecurityRule> {
 
                 evaluatedRules.push(evaluatedRule);
 
-            } catch (error) {
+            } catch (error: any) {
                 this.logger.error(`Error parsing security rule: ${rule.securityRuleConfig}`, error);
                 this.logger.error(error.stack);
                 throw error;

package/src/seeders/module-metadata-seeder.service.ts

@@ -238,7 +238,7 @@ export class ModuleMetadataSeederService {
 
             //FIXME: Handle displaying the created users credentials in a better way.
             // this.logger.log(`Newly created username is: ${usersDetail?.length > 0 ? usersDetail[0]?.username : ''} and password is ${usersDetail?.length > 0 ? usersDetail[0]?.password : ''}`);
-        } catch (error) {
+        } catch (error: any) {
             this.logSeedFailureForCli(error, {
                 moduleName: currentModule,
                 step: currentStep,
@@ -463,7 +463,7 @@ export class ModuleMetadataSeederService {
                     await this.createPermissionIfNotExists(permissionName);
                 }
 
-            } catch (error) {
+            } catch (error: any) {
                 this.logger.error(error);
             }
         }
@@ -544,7 +544,7 @@ export class ModuleMetadataSeederService {
                     moduleRoot = path.dirname(
                         require.resolve('@solidxai/core/package.json'),
                     );
-                } catch (err) {
+                } catch (err: any) {
                     this.logger.debug(
                         'Could not resolve @solidxai/core from node_modules, assuming local execution',
                     );
@@ -610,7 +610,7 @@ export class ModuleMetadataSeederService {
                     moduleRoot = path.dirname(
                         require.resolve('@solidxai/core/package.json'),
                     );
-                } catch (err) {
+                } catch (err: any) {
                     this.logger.debug(
                         'Could not resolve @solidxai/core from node_modules, assuming local execution',
                     );

package/src/seeders/permission-metadata-seeder.service.ts

@@ -52,7 +52,7 @@ export class PermissionMetadataSeederService {
           }
         }
 
-      } catch (error) {
+      } catch (error: any) {
         this.logger.error(error);
       }
     }

package/src/seeders/seed-data/solid-core-metadata.json

@@ -11552,7 +11552,7 @@
           "enableGlobalSearch": true,
           "create": true,
           "edit": true,
-          "delete": false
+          "delete": true
         },
         "children": [
           {
@@ -11570,7 +11570,18 @@
               "name": "name",
               "label": "Name",
               "sortable": true,
-              "filterable": true
+              "filterable": true,
+              "isSearchable": true
+            }
+          },
+          {
+            "type": "field",
+            "attrs": {
+              "name": "description",
+              "label": "Description",
+              "sortable": true,
+              "filterable": true,
+              "isSearchable": true
             }
           }
         ]