@solidstarters/solid-core 1.2.204 → 1.2.207

package/src/helpers/solid-registry.ts

@@ -5,11 +5,12 @@ import { CommonEntity } from 'src/entities/common.entity';
 import { Locale } from 'src/entities/locale.entity';
 import { SecurityRule } from 'src/entities/security-rule.entity';
 import { IScheduledJob } from 'src/services/scheduled-jobs/scheduled-job.interface';
-import { IDashboardQuestionDataProvider, IDashboardVariableSelectionProvider, IErrorCodeProvider, ISecurityRuleConfigProvider, ISelectionProvider, ISelectionProviderContext, ISolidDatabaseModule } from "../interfaces";
+import { IDashboardQuestionDataProvider, IDashboardVariableSelectionProvider, IErrorCodeProvider, ISecurityRuleConfigProvider, ISelectionProvider, ISelectionProviderContext, ISolidDatabaseModule, ISettingsProvider, SettingDefinition } from "../interfaces";
 import { DatasourceType } from 'src/dtos/create-model-metadata.dto';
 import { ObjectLiteral } from 'typeorm';
 import { ColumnMetadata } from 'typeorm/metadata/ColumnMetadata';
 import { RelationMetadata } from 'typeorm/metadata/RelationMetadata';
+import { Setting } from 'src/entities/setting.entity';
 
 type ControllerMetadata = {
   name: string;
@@ -84,6 +85,7 @@ export class SolidRegistry {
   private smsProviders: Set<InstanceWrapper> = new Set();
   private securityRuleConfigProviders: Set<InstanceWrapper> = new Set();
   private errorCodeProviders: Set<InstanceWrapper> = new Set();
+  private settingsProviders: Set<InstanceWrapper> = new Set();
 
   registerErrorCodeProvider(errorCodeProvider: InstanceWrapper): void {
     this.errorCodeProviders.add(errorCodeProvider);
@@ -145,6 +147,37 @@ export class SolidRegistry {
     this.modules = new Set(modules);
   }
 
+  registerSettingsProvider(provider: InstanceWrapper) {
+    this.settingsProviders.add(provider);
+  }
+
+  registerSecurityRules(securityRules: SecurityRule[]) {
+    this.securityRules = securityRules;
+  }
+
+  registerlocales(locales: Locale[]) {
+    this.locales = locales;
+  }
+
+  registerComputedFieldMetadata(computedFieldMetadata: ComputedFieldMetadata[]) {
+    this.computedFieldMetadata = computedFieldMetadata;
+  }
+
+  getSettingsProviders(): InstanceWrapper[] {
+    return Array.from(this.settingsProviders);
+  }
+
+  getSettingsProviderInstance<T extends ISelectionProviderContext>(name: string): ISelectionProvider<T> {
+    const settingsProviders = this.getSettingsProviders();
+
+    for (let i = 0; i < settingsProviders.length; i++) {
+      const settingsProvider = settingsProviders[i];
+      if (settingsProvider.instance.name() === name) {
+        return settingsProvider.instance;
+      }
+    }
+  }
+
   getMailProviders(): Array<InstanceWrapper> {
     return Array.from(this.mailProviders);
   }
@@ -236,10 +269,8 @@ export class SolidRegistry {
         return dasbhoardQuestionDataProvider.instance;
       }
     }
-
   }
 
-
   getComputedFieldProviders(): Array<InstanceWrapper> {
     return Array.from(this.computedFieldProviders);
   }
@@ -291,18 +322,6 @@ export class SolidRegistry {
     return module
   }
 
-  registerSecurityRules(securityRules: SecurityRule[]) {
-    this.securityRules = securityRules;
-  }
-
-  registerlocales(locales: Locale[]) {
-    this.locales = locales;
-  }
-
-  registerComputedFieldMetadata(computedFieldMetadata: ComputedFieldMetadata[]) {
-    this.computedFieldMetadata = computedFieldMetadata;
-  }
-
   getComputedFieldMetadata(): ComputedFieldMetadata[] {
     return this.computedFieldMetadata;
   }
@@ -328,4 +347,14 @@ export class SolidRegistry {
     // return Reflect.getMetadataKeys(CommonEntity.prototype) as (keyof CommonEntity)[];
   }
 
-}
+
+  getAllSettingsProviderInstance<T extends ISelectionProviderContext>(): ISelectionProvider<T> {
+    const settingsProviders = this.getSettingsProviders();
+
+    for (let i = 0; i < settingsProviders.length; i++) {
+      const settingsProvider = settingsProviders[i];
+      return settingsProvider.instance;
+    }
+  }
+}
+

package/src/index.ts

@@ -4,9 +4,6 @@ export * from './commands/refresh-module.command'
 export * from './commands/remove-fields.command'
 export * from './commands/seed.command'
 
-export * from './config/app-builder.config'
-export {default as commonConfig} from './config/common.config'
-export * from './config/iam.config'
 export * from './config/cache.options'
 
 export * from './decorators/active-user.decorator'
@@ -25,6 +22,7 @@ export * from './decorators/solid-service.decorator'
 export * from './decorators/mail-provider.decorator'
 export * from './decorators/security-rule-config-provider.decorator'
 export * from './decorators/sms-provider.decorator'
+export * from './decorators/settings-provider.decorator'
 
 export * from './dtos/post-chatter-message.dto'
 export * from './dtos/security-rule-config.dto'
@@ -236,7 +234,6 @@ export * from './services/hashing.service'
 export * from './services/list-of-values.service'
 export * from './services/mail/elastic-email.service'
 export * from './services/mail/smtp-email.service'
-export * from './services/media-storage-provider-metadata-seeder.service'
 export * from './services/media-storage-provider-metadata.service'
 export * from './services/media.service'
 export * from './services/mediaStorageProviders/file-s3-storage-provider'
@@ -267,6 +264,7 @@ export * from './services/user.service'
 export * from './services/view-metadata.service'
 export * from './services/whatsapp/Msg91WhatsappService' //rename
 export * from './services/setting.service'
+export * from './services/settings/default-settings-provider.service'
 export * from './services/security-rule.service'
 export * from './services/request-context.service'
 export * from './services/chatter-message.service'

package/src/interfaces.ts

@@ -58,6 +58,25 @@ export interface ModuleMetadataConfiguration {
   dashboards?: CreateDashboardDto[],
 }
 
+export enum SettingLevel {
+  SystemEnv = 'system-env',
+  SystemAdminReadonly = 'system-admin-readonly',
+  SystemAdminEditable = 'system-admin-editable',
+  InternalUser = "internal-user"
+}
+
+export interface SettingDefinition<T = any> {
+  moduleName: string;
+  key: string;
+  value: T;
+  level: SettingLevel;
+}
+
+// solid-core/settings/settings-provider.interface.ts
+export interface ISettingsProvider {
+  getSettings(): SettingDefinition[];
+}
+
 export interface CodeGenerationOptions {
   moduleId?: number;
   moduleUserKey?: string;
@@ -355,3 +374,13 @@ export interface McpComputedProviderResponse {
 export interface ISecurityRuleConfigProvider {
   securityRuleConfig(activeUser: ActiveUserData, securityRule: SecurityRule): Promise<SecurityRuleConfig>;
 }
+
+
+export interface AwsS3Config {
+  S3_AWS_ACCESS_KEY: string;
+  S3_AWS_SECRET_KEY: string;
+  S3_AWS_REGION_NAME: string;
+}
+
+// Prevents inference so callers must provide explicit type arguments; reusable for other APIs.
+export type NoInfer<T> = [T][T extends any ? 0 : never];

package/src/passport-strategies/google-oauth.strategy.ts

@@ -2,9 +2,8 @@ import { Inject, Injectable, Logger } from '@nestjs/common';
 import { ConfigType } from '@nestjs/config';
 import { AuthGuard, PassportStrategy } from '@nestjs/passport';
 import { Strategy, VerifyCallback } from 'passport-google-oauth2';
-import { isGoogleOAuthConfigured } from 'src/helpers/google-oauth.helper';
+import { GoogleAuthConfiguration, isGoogleOAuthConfigured } from 'src/helpers/google-oauth.helper';
 import { v4 as uuid } from 'uuid';
-import { iamConfig } from '../config/iam.config';
 import { UserService } from '../services/user.service';
 
 const DUMMY_CLIENT_ID = 'DUMMY_CLIENT_ID';
@@ -19,19 +18,23 @@ export class GoogleOauthGuard extends AuthGuard('google') { }
 export class GoogleOauthStrategy extends PassportStrategy(Strategy, 'google') {
   private readonly logger = new Logger(GoogleOauthStrategy.name);
   constructor(
-    @Inject(iamConfig.KEY) private iamConfiguration: ConfigType<typeof iamConfig>,
     private readonly userService: UserService
   ) {
     // TODO: Have added default dummy values for the configuration, since the configuration is not mandatory.
     // Perhaps a cleaner way needs to be figured out
     super({
-      clientID: iamConfiguration.googleOauth.clientID ?? DUMMY_CLIENT_ID,
-      clientSecret: iamConfiguration.googleOauth.clientSecret ?? DUMMY_CLIENT_SECRET,
-      callbackURL: iamConfiguration.googleOauth.callbackURL ?? DUMMY_CALLBACK_URL,
+      clientID: process.env.IAM_GOOGLE_OAUTH_CLIENT_ID ?? DUMMY_CLIENT_ID,
+      clientSecret: process.env.IAM_GOOGLE_OAUTH_CLIENT_SECRET ?? DUMMY_CLIENT_SECRET,
+      callbackURL: process.env.IAM_GOOGLE_OAUTH_CALLBACK_URL ?? DUMMY_CALLBACK_URL,
       scope: ['profile', 'email'],
     });
-
-    if (!isGoogleOAuthConfigured(iamConfiguration)) {
+    const googleOauth: GoogleAuthConfiguration = {
+      clientID: process.env.IAM_GOOGLE_OAUTH_CLIENT_ID,
+      clientSecret: process.env.IAM_GOOGLE_OAUTH_CLIENT_SECRET,
+      callbackURL: process.env.IAM_GOOGLE_OAUTH_CALLBACK_URL,
+      redirectURL: process.env.IAM_GOOGLE_OAUTH_REDIRECT_URL,
+    }
+    if (!isGoogleOAuthConfigured(googleOauth)) {
       this.logger.debug('Google OAuth strategy is not configured');
     }
   }

package/src/repository/scheduled-job.repository.ts

@@ -70,6 +70,7 @@ export class ScheduledJobRepository extends SolidBaseRepository<ScheduledJob> {
       job: populatedScheduledJob.job,
       moduleUserKey: populatedScheduledJob.module.name,
       moduleId: populatedScheduledJob.module.id,
+      cronExpression: populatedScheduledJob.cronExpression,
     };
   }
 

package/src/seeders/email-template-seeder.service.ts

@@ -1,11 +1,12 @@
 import { Inject, Injectable, Logger } from '@nestjs/common';
 import * as fs from 'fs';
 import * as path from 'path';
+import type { SolidCoreSetting } from "src/services/settings/default-settings-provider.service";
 
 import { ConfigType } from '@nestjs/config';
 import { EmailTemplateService } from '../services/email-template.service';
-import commonConfig from '../config/common.config';
 import { CreateEmailTemplateDto } from '../dtos/create-email-template.dto';
+import { SettingService } from 'src/services/setting.service';
 
 @Injectable()
 export class EmailTemplateSeederService {
@@ -13,13 +14,14 @@ export class EmailTemplateSeederService {
 
     constructor(
         private readonly emailTemplateService: EmailTemplateService,
-        @Inject(commonConfig.KEY)
-        private readonly commonConfiguration: ConfigType<typeof commonConfig>,
+        private readonly settingService: SettingService
     ) { }
 
     async seed() {
         // Read the module metadata from a file specified in the .env 
-        const seedDataFiles = this.commonConfiguration.emailTemplateSeederFiles.split(',');
+        const seedDataFileVariable = this.settingService.getConfigValue<SolidCoreSetting>("emailTemplateSeederFiles");
+        const seedDataFiles = seedDataFileVariable.split(',');
+
         for (let i = 0; i < seedDataFiles.length; i++) {
             const seedDataFile = seedDataFiles[i];
             const fullPath = path.join(process.cwd(), seedDataFile);

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

@@ -1,3 +1,4 @@
+
 import { forwardRef, Inject, Injectable, Logger } from '@nestjs/common';
 import * as fs from 'fs';
 import * as path from 'path';
@@ -7,7 +8,6 @@ import { CreateDashboardDto } from 'src/dtos/create-dashboard.dto';
 import { CreateEmailTemplateDto } from 'src/dtos/create-email-template.dto';
 import { CreateListOfValuesDto } from 'src/dtos/create-list-of-values.dto';
 import { CreateSecurityRuleDto } from 'src/dtos/create-security-rule.dto';
-import { CreateSettingDto } from 'src/dtos/create-setting.dto';
 import { CreateSmsTemplateDto } from 'src/dtos/create-sms-template.dto';
 import { DashboardRepository } from 'src/repository/dashboard.repository';
 import { SecurityRuleRepository } from 'src/repository/security-rule.repository';
@@ -17,15 +17,13 @@ import { ListOfValuesService } from 'src/services/list-of-values.service';
 import { SettingService } from 'src/services/setting.service';
 import { SmsTemplateService } from 'src/services/sms-template.service';
 import { UserService } from 'src/services/user.service';
-import { DataSource, In, Repository } from 'typeorm';
-import appBuilderConfig from '../config/app-builder.config';
+import { DataSource, In } from 'typeorm';
 import { CreateModelMetadataDto } from '../dtos/create-model-metadata.dto';
 import { CreateModuleMetadataDto } from '../dtos/create-module-metadata.dto';
-import { getDynamicModuleNames, getDynamicModuleNamesBasedOnMetadata } from '../helpers/module.helper';
+import { getDynamicModuleNamesBasedOnMetadata } from '../helpers/module.helper';
 import { SolidRegistry } from '../helpers/solid-registry';
 import { ActionMetadataService } from '../services/action-metadata.service';
 import { FieldMetadataService } from '../services/field-metadata.service';
-import { MediaStorageProviderMetadataSeederService } from '../services/media-storage-provider-metadata-seeder.service';
 import { MediaStorageProviderMetadataService } from '../services/media-storage-provider-metadata.service';
 import { ModelMetadataService } from '../services/model-metadata.service';
 import { ModuleMetadataService } from '../services/module-metadata.service';
@@ -35,7 +33,7 @@ import solidCoreMetadata from './seed-data/solid-core-metadata.json';
 import { SystemFieldsSeederService } from './system-fields-seeder.service';
 // import { CreateScheduledJobDto } from 'src/dtos/create-scheduled-job.dto';
 import { ActionMetadata, MENU_ROLE_JOIN_TABLE_NAME, MENU_ROLE_JOIN_TABLE_NAME_MENU_COL, MENU_ROLE_JOIN_TABLE_NAME_ROLE_COL, MenuItemMetadata, ModuleMetadata, RoleMetadata, SignUpDto } from 'src';
-import { ADMIN_ROLE_NAME, INTERNAL_ROLE_NAME, INTERNAL_ROLE_PERMISSIONS, PUBLIC_ROLE_NAME } from 'src/dtos/create-role-metadata.dto';
+import { ADMIN_ROLE_NAME } from 'src/dtos/create-role-metadata.dto';
 import { CreateSavedFiltersDto } from 'src/dtos/create-saved-filters.dto';
 import { CreateScheduledJobDto } from 'src/dtos/create-scheduled-job.dto';
 import { PermissionMetadataRepository } from 'src/repository/permission-metadata.repository';
@@ -62,7 +60,6 @@ export class ModuleMetadataSeederService {
         private readonly authenticationService: AuthenticationService,
         private readonly solidActionService: ActionMetadataService,
         private readonly solidViewService: ViewMetadataService,
-        private readonly mediaStorageProviderSeederService: MediaStorageProviderMetadataSeederService,
         private readonly emailTemplateService: EmailTemplateService,
         private readonly smsTemplateService: SmsTemplateService,
         private readonly listOfValuesService: ListOfValuesService,
@@ -91,7 +88,7 @@ export class ModuleMetadataSeederService {
         // Module specific seeding steps.
         // Get all the module metadata files which needs to be seeded.
         const seedDataFiles = this.seedDataFiles;
-        this.logger.debug(`Seed data files are: ${seedDataFiles}`);
+        this.logger.debug(`Found seed data for modules: ${seedDataFiles.map(s => s.moduleMetadata?.name)}`);
 
         /** -------------------------------------------------------------
          * Selective module seeding via: 
@@ -102,8 +99,10 @@ export class ModuleMetadataSeederService {
 
         if (conf && Array.isArray(conf.modulesToSeed)) {
             modulesToSeed = conf.modulesToSeed;
+            console.log(`▶ Selective seeding enabled. Modules to seed: ${modulesToSeed.join(', ')}`);
             this.logger.log(`Selective seeding enabled. Modules to seed: ${modulesToSeed.join(', ')}`);
         } else {
+            console.log(`▶ No modulesToSeed provided. Seeding ALL modules.`);
             this.logger.log(`No modulesToSeed provided. Seeding ALL modules.`);
         }
 
@@ -124,69 +123,81 @@ export class ModuleMetadataSeederService {
         for (let i = 0; i < filteredSeedDataFiles.length; i++) {
             const overallMetadata = filteredSeedDataFiles[i];
             const moduleMetadata: CreateModuleMetadataDto = overallMetadata.moduleMetadata;
+            console.log(`▶ Seeding Metadata for Module: ${moduleMetadata.name}`);
             this.logger.log(`Seeding Metadata for Module: ${moduleMetadata.name}`);
 
             // Process module metadata first. 
+            console.log(`▶ [${moduleMetadata.name}] Seeding Module / Model / Fields`);
             this.logger.log(`Seeding Module / Model / Fields`);
             await this.seedModuleModelFields(moduleMetadata);
 
             // Media Storage provider templates
+            console.log(`▶ [${moduleMetadata.name}] Seeding Media Storage Providers`);
             this.logger.log(`Seeding Media Storage Providers`);
             await this.seedMediaStorageProviders(overallMetadata.mediaStorageProviders);
 
             // Custom role handling
+            console.log(`▶ [${moduleMetadata.name}] Seeding Roles`);
             this.logger.log(`Seeding Roles`);
             await this.seedRoles(overallMetadata);
 
             // Custom user handling
+            console.log(`▶ [${moduleMetadata.name}] Seeding Users`);
             this.logger.log(`Seeding Users`);
             await this.seedUsers(overallMetadata);
 
             // Application Module View handling 
+            console.log(`▶ [${moduleMetadata.name}] Seeding Views`);
             this.logger.log(`Seeding Views`);
             await this.seedViews(overallMetadata);
 
             // Application Module Action handling
+            console.log(`▶ [${moduleMetadata.name}] Seeding Actions`);
             this.logger.log(`Seeding Actions`);
             await this.seedActions(overallMetadata);
 
             // Application Module Menu handling 
+            console.log(`▶ [${moduleMetadata.name}] Seeding Menus`);
             this.logger.log(`Seeding Menus`);
             await this.seedMenus(overallMetadata);
 
             // Email templates 
+            console.log(`▶ [${moduleMetadata.name}] Seeding Email Templates`);
             this.logger.log(`Seeding Email Templates`);
             await this.seedEmailTemplates(overallMetadata, moduleMetadata.name);
 
             // Sms templates
+            console.log(`▶ [${moduleMetadata.name}] Seeding Sms Templates`);
             this.logger.log(`Seeding Sms Templates`);
             await this.seedSmsTemplates(overallMetadata, moduleMetadata.name);
 
-            // Settings
-            this.logger.log(`Seeding Default Settings`);
-            await this.seedDefaultSettings();
-
             // Security rules
+            console.log(`▶ [${moduleMetadata.name}] Seeding Security Rules`);
             this.logger.log(`Seeding Security Rules`);
             await this.seedSecurityRules(overallMetadata);
 
             // List Of Values
+            console.log(`▶ [${moduleMetadata.name}] Seeding List Of Values`);
             this.logger.log(`Seeding List Of Values`);
             await this.seedListOfValues(moduleMetadata, overallMetadata);
 
             // Dashboards
+            console.log(`▶ [${moduleMetadata.name}] Seeding Dashboards`);
             this.logger.log(`Seeding Dashboards`);
             await this.seedDashboards(moduleMetadata, overallMetadata);
 
             // Scheduled Jobs
+            console.log(`▶ [${moduleMetadata.name}] Seeding Scheduled Jobs`);
             this.logger.log(`Seeding Scheduled Jobs`);
             await this.seedScheduledJobs(moduleMetadata, overallMetadata);
 
             // Saved Filters
+            console.log(`▶ [${moduleMetadata.name}] Seeding Saved Filters`);
             this.logger.log(`Seeding Saved Filters`);
             await this.seedSavedFilters(moduleMetadata, overallMetadata);
 
             // Model Sequences
+            console.log(`▶ [${moduleMetadata.name}] Seeding Model Sequences`);
             this.logger.log(`Seeding Model Sequences`);
             await this.seedModelSequences(overallMetadata);
 
@@ -197,7 +208,7 @@ export class ModuleMetadataSeederService {
         await this.setupDefaultRolesWithPermissions();
 
         // Add a console log indicating seeding is finished. This needs to be console.log so that it looks proper when this code is run via CLI.
-        console.log(`Seeding completed.`);
+        console.log(`✔ Seeding completed.`);
         //this.logger.log(`All Seeders finished`);
 
         //FIXME: Handle displaying the created users credentials in a better way.
@@ -239,11 +250,13 @@ export class ModuleMetadataSeederService {
     private async setupDefaultRolesWithPermissions() {
         this.logger.debug(`About to add all permissions to the Admin role`);
         await this.roleService.addAllPermissionsToRole(ADMIN_ROLE_NAME);
+
         // 2. Give  permissions to the Internal / Public role.
-        this.logger.debug(`About to add all permissions to the Internal role`);
-        await this.roleService.addPermissionToRole(INTERNAL_ROLE_NAME, INTERNAL_ROLE_PERMISSIONS);
-        this.logger.debug(`About to add all permissions to the Public role`);
-        await this.roleService.addPermissionToRole(PUBLIC_ROLE_NAME, ['SettingController.wrapSettings', 'AuthenticationController.logout']);
+        // this.logger.debug(`About to add all permissions to the Internal role`);
+        // await this.roleService.addPermissionToRole(INTERNAL_ROLE_NAME, INTERNAL_ROLE_PERMISSIONS);
+
+        // this.logger.debug(`About to add all permissions to the Public role`);
+        // await this.roleService.addPermissionToRole(PUBLIC_ROLE_NAME, ['SettingController.wrapSettings', 'AuthenticationController.logout']);
     }
 
     private async seedSecurityRules(overallMetadata: any) {
@@ -256,7 +269,7 @@ export class ModuleMetadataSeederService {
     // Ok
     private async seedDefaultSettings() {
         this.logger.debug(`[Start] Processing settings`);
-        await this.settingService.seedDefaultSettings();
+        await this.settingService.seedSystemAdminEditableAndAboveSettings();
         this.logger.debug(`[End] Processing settings`);
     }
 
@@ -347,12 +360,17 @@ export class ModuleMetadataSeederService {
         this.logger.log(`Seeding Permissions`);
         await this.seedPermissions();
 
-        this.logger.log(`Seeding Default Media Storage Providers`);
-        await this.seedDefaultMediaStorageProviders();
+        // this.logger.log(`Seeding Default Media Storage Providers`);
+        // await this.seedDefaultMediaStorageProviders();
 
         this.logger.log(`Seeding System Fields Metadata`);
         await this.seedDefaultSystemFields();
 
+        // Settings
+        this.logger.log(`Seeding Default Settings`);
+        await this.seedDefaultSettings();
+
+
         this.logger.debug(`Global metadata seeding completed`);
     }
 
@@ -409,9 +427,9 @@ export class ModuleMetadataSeederService {
     }
 
     // OK
-    private async seedDefaultMediaStorageProviders() {
-        await this.mediaStorageProviderSeederService.seed();
-    }
+    // private async seedDefaultMediaStorageProviders() {
+    //     await this.mediaStorageProviderSeederService.seed();
+    // }
 
     // OK
     private async seedMediaStorageProviders(mediaStorageProviders: any[]) {
@@ -815,12 +833,6 @@ export class ModuleMetadataSeederService {
         this.logger.debug(`[End] Processing module metadata`);
     }
 
-    private async seedSettings(createDto: CreateSettingDto) {
-        const settingsArray: any[] = await this.settingsRepo.find();
-        if (!settingsArray || settingsArray.length === 0) {
-            this.settingService.create(createDto);
-        }
-    }
 
     private async handleSeedSecurityRules(rulesDto: CreateSecurityRuleDto[]) {
         if (!rulesDto || rulesDto.length === 0) {