@solidxai/core 0.1.9-beta.1 → 0.1.9-beta.10

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

@@ -0,0 +1,116 @@
+import {
+  Controller,
+  Get,
+  Inject,
+  InternalServerErrorException,
+  Query,
+  Req,
+  Res,
+  UseGuards,
+} from "@nestjs/common";
+import { ApiQuery, ApiTags } from "@nestjs/swagger";
+import { Request, Response } from "express";
+import {
+  MicrosoftAuthConfiguration,
+  isMicrosoftOAuthConfigured,
+} from "../helpers/microsoft-oauth.helper";
+import { AuthenticationService } from "../services/authentication.service";
+import { SettingService } from "../services/setting.service";
+import { Public } from "src/decorators/public.decorator";
+import { Auth } from "../decorators/auth.decorator";
+import { AuthType } from "../enums/auth-type.enum";
+import { MicrosoftOauthGuard } from "../passport-strategies/microsoft-oauth.strategy";
+import { UserService } from "../services/user.service";
+import type { SolidCoreSetting } from "../services/settings/default-settings-provider.service";
+
+@Auth(AuthType.None)
+@ApiTags("Iam")
+@Controller("iam/microsoft")
+export class MicrosoftAuthenticationController {
+  constructor(
+    private readonly userService: UserService,
+    private readonly authService: AuthenticationService,
+    private readonly settingService: SettingService,
+  ) {}
+
+  private async getConfiguration(): Promise<MicrosoftAuthConfiguration> {
+    return {
+      clientID:
+        await this.settingService.getConfigValue<SolidCoreSetting>(
+          "MICROSOFT_CLIENT_ID" as any,
+        ),
+      clientSecret: await this.settingService.getConfigValue<SolidCoreSetting>(
+        "MICROSOFT_CLIENT_SECRET" as any,
+      ),
+      tenant: await this.settingService.getConfigValue<SolidCoreSetting>(
+        "MICROSOFT_TENANT_ID" as any,
+      ),
+      callbackURL: await this.settingService.getConfigValue<SolidCoreSetting>(
+        "MICROSOFT_CALLBACK_URL" as any,
+      ),
+      redirectURL: await this.settingService.getConfigValue<SolidCoreSetting>(
+        "MICROSOFT_REDIRECT_URL" as any,
+      ),
+    };
+  }
+
+  private async validateConfiguration() {
+    const config = await this.getConfiguration();
+    if (!isMicrosoftOAuthConfigured(config)) {
+      throw new InternalServerErrorException(
+        "Microsoft OAuth is not configured",
+      );
+    }
+    return config;
+  }
+
+  @Public()
+  @UseGuards(MicrosoftOauthGuard)
+  @Get("connect")
+  async connect() {
+    await this.validateConfiguration();
+  }
+
+  @Public()
+  @Get("connect/callback")
+  @UseGuards(MicrosoftOauthGuard)
+  async microsoftAuthCallback(@Req() req: Request, @Res() res: Response) {
+    const config = await this.validateConfiguration();
+    const user = req.user;
+    return res.redirect(`${config.redirectURL}?accessCode=${user['accessCode']}`);
+  }
+
+  /**
+   * This is just a dummy endpoint where we are passing in the accessCode, this will be configured in the .env as an environment variable and 
+   * will be passed the accessCode, using the accessCode the UI code on this page will mostly invoke the /iam/microsoft/auth endpoint which will finally generate the JWT token.
+   * 
+   * @param accessCode 
+   * @returns 
+   */
+  @Public()
+  @Get('dummy-redirect')
+  async dummyMicrosoftAuthRedirect(@Query('accessCode') accessCode) {
+      await this.validateConfiguration();
+      const user = await this.userService.findOneByAccessCode(accessCode);
+
+      if (user) {
+          delete user['password'];
+      }
+
+      return user;
+  }
+
+  /**
+   * Use this endpoint to authenticate using an accessCode with Microsoft.
+   * 
+   * @param accessCode 
+   * @returns 
+   */
+  @Public()
+  @Get("authenticate")
+  @ApiQuery({ name: "accessCode", required: true, type: String })
+  async microsoftAuth(@Query("accessCode") accessCode: string) {
+    await this.validateConfiguration();
+    return this.authService.signInUsingMicrosoft(accessCode);
+  }
+}

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

@@ -22,11 +22,11 @@ export class OTPAuthenticationController {
     @Public()
     @Post('register/initiate')
     initiateRegistration(@Body() signUpDto: OTPSignUpDto) {
-        return this.authService.otpInitiateRegistration(signUpDto); //TODO finalize if 200 or 201 to be returned
+        return this.authService.otpInitiateRegistration(signUpDto);
     }
 
     @Public()
-    @HttpCode(HttpStatus.OK) // by default @Post does 201, we wanted 200 - hence using @HttpCode(HttpStatus.OK)
+    @HttpCode(HttpStatus.OK)
     @Post('register/confirm')
     async confirmRegistration(
         @Res({ passthrough: true }) response: Response,

package/src/controllers/setting.controller.ts

@@ -36,13 +36,13 @@ export class SettingController {
   @Get('/wrapped')
   @Public()
   async wrapSettings() {
-    return this.service.getSystemAdminReadonlyAndAboveSettings();
+    return this.service.getNonEncryptedSystemAdminReadonlyAndAboveSettings();
   }
 
   @ApiBearerAuth("jwt")
   @Get()
   async getAllSettings() {
-    return this.service.getSystemAdminReadonlyAndAboveSettings();
+    return this.service.getNonEncryptedSystemAdminReadonlyAndAboveSettings();
   }
 
   @ApiBearerAuth("jwt")

package/src/decorators/extension-user-creation-provider.decorator.ts

@@ -0,0 +1,5 @@
+export const IS_EXTENSION_USER_CREATION_PROVIDER = 'IS_EXTENSION_USER_CREATION_PROVIDER';
+
+export const ExtensionUserCreationProvider = () =>
+  (target: Function) =>
+    Reflect.defineMetadata(IS_EXTENSION_USER_CREATION_PROVIDER, true, target);

package/src/dtos/create-chatter-message.dto.ts

@@ -7,28 +7,39 @@ export class CreateChatterMessageDto {
     @IsString()
     @ApiProperty()
     messageType: string;
+
     @IsNotEmpty()
     @IsString()
     @ApiProperty()
     messageSubType: string;
+
     @IsOptional()
     @IsString()
     @ApiProperty()
     messageBody: string;
+
     @IsNotEmpty()
     @IsInt()
     @ApiProperty()
     coModelEntityId: number;
+
     @IsNotEmpty()
     @IsString()
     @ApiProperty()
     coModelName: string;
+
     @IsOptional()
     @IsInt()
     @ApiProperty()
     userId: number;
+
     @IsString()
     @IsOptional()
     @ApiProperty()
     userUserKey: string;
+
+    @IsString()
+    @IsOptional()
+    @ApiProperty()
+    status: string;
 }

package/src/dtos/create-field-metadata.dto.ts

@@ -385,7 +385,7 @@ export class CreateFieldMetadataDto {
   @ApiProperty({ description: 'Static values for selection. Only for type=selectionStatic', })
   @IsArray()
   @IsString({ each: true })
-  @Matches(/^[\w\s\d\-\/]+:[\w\s\-\/]+$/, { each: true })
+  // @Matches(/^[\w\s\d\-\/]+:[\w\s\-\/]+$/, { each: true })
   @IsOptional()
   selectionStaticValues: string[];
 

package/src/dtos/create-user.dto.ts

@@ -126,6 +126,10 @@ export class CreateUserDto {
     @ApiProperty()
     customPayload: string;
     @IsOptional()
+    @IsBoolean()
+    @ApiProperty()
+    isAllowedToGenerateApiKeys: boolean = false;
+    @IsOptional()
     @ApiProperty()
     @IsArray()
     @ValidateNested({ each: true })

package/src/dtos/post-chatter-message.dto.ts

@@ -20,4 +20,8 @@ export class PostChatterMessageDto {
     @IsString()
     @IsOptional()
     modelUserKey?: string;
+
+    @IsString()
+    @IsOptional()
+    status?: string;
 }

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

@@ -1,41 +1,53 @@
-import { IsInt,IsOptional, IsString, IsNotEmpty } from 'class-validator';
+import { IsInt, IsOptional, IsString, IsNotEmpty } from 'class-validator';
 import { ApiProperty } from '@nestjs/swagger';
 
 export class UpdateChatterMessageDto {
     @IsOptional()
     @IsInt()
     id: number;
+
     @IsNotEmpty()
     @IsOptional()
     @IsString()
     @ApiProperty()
     messageType: string;
+
     @IsNotEmpty()
     @IsOptional()
     @IsString()
     @ApiProperty()
     messageSubType: string;
+
     @IsNotEmpty()
     @IsOptional()
     @IsString()
     @ApiProperty()
     messageBody: string;
+
     @IsNotEmpty()
     @IsOptional()
     @IsInt()
     @ApiProperty()
     coModelEntityId: number;
+
     @IsNotEmpty()
     @IsOptional()
     @IsString()
     @ApiProperty()
     coModelName: string;
+
     @IsOptional()
     @IsInt()
     @ApiProperty()
     userId: number;
+
     @IsString()
     @IsOptional()
     @ApiProperty()
     userUserKey: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty()
+    status: string;
 }

package/src/dtos/update-user.dto.ts

@@ -130,6 +130,10 @@ export class UpdateUserDto {
     @ApiProperty()
     customPayload: string;
     @IsOptional()
+    @IsBoolean()
+    @ApiProperty()
+    isAllowedToGenerateApiKeys: boolean;
+    @IsOptional()
     @ApiProperty()
     @IsArray()
     @ValidateNested({ each: true })

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

@@ -12,7 +12,7 @@ export class ChatterMessage extends CommonEntity {
     messageType: string; // audit | custom 
 
     @Column({ type: "varchar" })
-    messageSubType: string; // audit_update | audit_insert | audit_delete | custom
+    messageSubType: string; // audit_update | audit_insert | audit_delete | custom | note | task
 
     @Column({ nullable: true, ...getColumnType('longText') })
     messageBody: string;
@@ -38,4 +38,7 @@ export class ChatterMessage extends CommonEntity {
 
     @Column({ nullable: true })
     modelUserKey: string;
+
+    @Column({ default: 'pending' })
+    status: string; // pending | completed
 }

package/src/entities/user.entity.ts

@@ -56,6 +56,38 @@ export class User extends CommonEntity {
     // don't send to client
     googleProfilePicture: string;
 
+    @Column({ type: "varchar", nullable: true })
+    // don't send to client
+    facebookId: string;
+
+    @Column({ type: "varchar", nullable: true })
+    // don't send to client
+    facebookAccessToken: string;
+
+    @Column({ type: "varchar", nullable: true })
+    // don't send to client
+    facebookProfilePicture: string;
+
+    @Column({ type: "varchar", nullable: true })
+    // don't send to client
+    appleId: string;
+
+    @Column({ type: "varchar", nullable: true })
+    // don't send to client
+    appleAccessToken: string;
+
+    @Column({ type: "varchar", nullable: true })
+    // don't send to client
+    microsoftId: string;
+
+    @Column({ type: "varchar", nullable: true })
+    // don't send to client
+    microsoftAccessToken: string;
+
+    @Column({ type: "varchar", nullable: true })
+    // don't send to client
+    microsoftProfilePicture: string;
+
     @Column({ default: true })
     @Expose()
     active: boolean = true;
@@ -157,6 +189,7 @@ export class User extends CommonEntity {
     isAllowedToGenerateApiKeys: boolean = false;
 
     @OneToMany(() => UserApiKey, key => key.user)
+    @Expose()
     apiKeys: UserApiKey[];
 
 }

package/src/helpers/bootstrap.helper.ts

@@ -6,8 +6,9 @@ import helmet from 'helmet';
 import qs from 'qs';
 import { existsSync } from 'fs';
 import { resolve } from 'path';
-import { WINSTON_MODULE_NEST_PROVIDER } from 'nest-winston';
+import { WINSTON_MODULE_NEST_PROVIDER, WinstonModule } from 'nest-winston';
 import { CommandFactory } from 'nest-commander';
+import { WinstonLoggerConfig } from '../winston.logger';
 import { WrapResponseInterceptor } from '../interceptors/wrap-response.interceptor';
 import { buildDefaultCorsOptions } from './cors.helper';
 import { buildDefaultSecurityHeaderOptions, buildPermissionsPolicyHeader, PermissionsPolicyConfig } from './security.helper';
@@ -71,7 +72,9 @@ export async function bootstrapSolidApp(
   const { globalPrefix = 'api', swagger = {}, permissionsPolicyOverrides = {} } = options;
 
   const appModule = await appModuleFactory();
-  const app = await NestFactory.create(appModule);
+  const app = await NestFactory.create(appModule, {
+    logger: WinstonModule.createLogger(WinstonLoggerConfig),
+  });
 
   const apiEnabled = parseBooleanEnv('API_ENABLED', true);
 

package/src/helpers/cors.helper.ts

@@ -42,7 +42,7 @@ export function buildDefaultCorsOptions(): CorsOptions {
       return cb(new Error(`Origin ${origin} not allowed by CORS. Allowed origins: ${allowed.join(', ')}`), false);
     },
     methods: ['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS'],
-    allowedHeaders: ['Content-Type', 'Authorization'],
+    allowedHeaders: ['Content-Type', 'Authorization','solidx-api-key'],
     credentials: true,
   };
 }

package/src/helpers/facebook-oauth.helper.ts

@@ -0,0 +1,17 @@
+export type FacebookAuthConfiguration = {
+  clientID: string;
+  clientSecret: string;
+  callbackURL: string;
+  redirectURL: string;
+};
+
+export const isFacebookOAuthConfigured = (
+  config: FacebookAuthConfiguration,
+): boolean => {
+  return !!(
+    config.clientID &&
+    config.clientSecret &&
+    config.callbackURL &&
+    config.redirectURL
+  );
+};

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

@@ -1,4 +1,4 @@
-import { classify } from "@angular-devkit/core/src/utils/strings";
+import { classify } from '../string.helper';
 import { Logger } from "@nestjs/common";
 import { isEmpty, isEnum, isNotEmpty } from "class-validator";
 import { RelationFieldsCommand } from "src/dtos/create-field-metadata.dto";

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

@@ -1,4 +1,4 @@
-import { classify } from "@angular-devkit/core/src/utils/strings";
+import { classify } from '../string.helper';
 import { BadRequestException } from "@nestjs/common";
 import { isEmpty, isNotEmpty, isString } from "class-validator";
 import { FieldCrudManager, ValidationError } from "src/interfaces";
@@ -87,7 +87,6 @@ export class ManyToOneRelationFieldCrudManager implements FieldCrudManager {
             }
         }
 
-
         return dto;
     }
 

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

@@ -1,4 +1,4 @@
-import { classify } from "@angular-devkit/core/src/utils/strings";
+import { classify } from '../string.helper';
 import { Logger } from "@nestjs/common";
 import { isEmpty, isEnum, isInt, isNotEmpty } from "class-validator";
 import { RelationFieldsCommand } from "src/dtos/create-field-metadata.dto";

package/src/helpers/microsoft-oauth.helper.ts

@@ -0,0 +1,19 @@
+export type MicrosoftAuthConfiguration = {
+  clientID: string;
+  clientSecret: string;
+  tenant: string;
+  callbackURL: string;
+  redirectURL: string;
+};
+
+export const isMicrosoftOAuthConfigured = (
+  config: MicrosoftAuthConfiguration,
+): boolean => {
+  return !!(
+    config.clientID &&
+    config.clientSecret &&
+    config.tenant &&
+    config.callbackURL &&
+    config.redirectURL
+  );
+};

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

@@ -1,4 +1,4 @@
-import { dasherize } from "@angular-devkit/core/src/utils/strings";
+import { kebabCase } from 'lodash';
 import { Injectable, Logger } from "@nestjs/common";
 import * as fs from 'fs/promises'; // Use the Promise-based version of fs for async/await
 import * as path from 'path'; // To handle file paths
@@ -41,7 +41,7 @@ export class ModuleMetadataHelperService {
         if (!moduleName) {
             return '';
         }
-        const dashModuleName = dasherize(moduleName);
+        const dashModuleName = kebabCase(moduleName);
         const folderPath = path.resolve(process.cwd(), 'module-metadata', dashModuleName);
         const filePath = path.join(folderPath, `${dashModuleName}-metadata.json`);
         // Check if filePath exists
@@ -62,7 +62,7 @@ export class ModuleMetadataHelperService {
             return '';
         }
 
-        const dashModuleName = dasherize(moduleName);
+        const dashModuleName = kebabCase(moduleName);
 
         const folderPath = path.resolve(
             process.cwd(),

package/src/helpers/solid-registry.ts

@@ -1,5 +1,7 @@
-import { Injectable } from '@nestjs/common';
+import { Injectable, Logger } from '@nestjs/common';
 import { InstanceWrapper } from '@nestjs/core/injector/instance-wrapper';
+import { IExtensionUserCreationProvider } from 'src/interfaces';
+import { User } from 'src/entities/user.entity';
 import { ComputedFieldTriggerConfig, ComputedFieldValueType } from 'src/dtos/create-field-metadata.dto';
 import { CommonEntity } from 'src/entities/common.entity';
 import { Locale } from 'src/entities/locale.entity';
@@ -64,6 +66,8 @@ export interface ComputedFieldMetadata<TContext = any> {
 
 @Injectable()
 export class SolidRegistry {
+  private readonly logger = new Logger(SolidRegistry.name);
+  private extensionUserCreationProvider: InstanceWrapper | null = null;
   private seeders: Set<InstanceWrapper> = new Set();
   private scheduledJobProviders: Set<InstanceWrapper> = new Set();
   private selectionProviders: Set<InstanceWrapper> = new Set();
@@ -84,6 +88,20 @@ export class SolidRegistry {
   private settingsProviders: Set<InstanceWrapper> = new Set();
   private auditableModels: Set<string> = new Set();
 
+  registerExtensionUserCreationProvider(provider: InstanceWrapper): void {
+    if (this.extensionUserCreationProvider) {
+      this.logger.warn(
+        `ExtensionUserCreationProvider already registered by ${this.extensionUserCreationProvider.name}; ignoring ${provider.name}`,
+      );
+      return;
+    }
+    this.extensionUserCreationProvider = provider;
+  }
+
+  getExtensionUserCreationProvider<T extends User = User>(): IExtensionUserCreationProvider<T, any> | null {
+    return (this.extensionUserCreationProvider?.instance as IExtensionUserCreationProvider<T, any>) ?? null;
+  }
+
   registerErrorCodeProvider(errorCodeProvider: InstanceWrapper): void {
     this.errorCodeProviders.add(errorCodeProvider);
   }

package/src/helpers/string.helper.ts

@@ -2,3 +2,6 @@ export const lowerFirst = (str: string): string => {
     if (!str) return str;
     return str.charAt(0).toLowerCase() + str.slice(1);
 }
+
+import { upperFirst, camelCase } from 'lodash';
+export const classify = (s: string): string => upperFirst(camelCase(s));

package/src/helpers/user-helper.ts

@@ -11,6 +11,10 @@ export function getUserExcludedFields(): string[] {
     "forcePasswordChange",
     "lastLoginProvider",
     "googleProfilePicture",
+    "facebookAccessToken",
+    "facebookId",
+    "microsoftAccessToken",
+    "microsoftId",
     "forgotPasswordConfirmedAt",
     "verificationTokenOnForgotPassword",
     "verificationTokenOnForgotPasswordExpiresAt",

package/src/index.ts

@@ -26,6 +26,7 @@ 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 './decorators/extension-user-creation-provider.decorator'
 
 export * from './dtos/post-chatter-message.dto'
 export * from './dtos/security-rule-config.dto'
@@ -260,6 +261,8 @@ export * from './jobs/redis/twilio-sms-subscriber-redis.service'
 export * from './listeners/user-registration.listener'
 
 export * from './passport-strategies/google-oauth.strategy'
+export * from './passport-strategies/facebook-oauth.strategy'
+export * from './passport-strategies/microsoft-oauth.strategy'
 
 export * from './services/selection-providers/list-of-values-selection-providers.service'
 

package/src/interfaces/mq.ts

@@ -19,5 +19,5 @@ export interface QueuePublisher<T> {
 
 export interface QueueSubscriber<T> {
     options(): QueuesModuleOptions;
-    subscribe(message: QueueMessage<T>): void;
-}
+    subscribe(message: QueueMessage<T>): Promise<any>;
+}

package/src/interfaces.ts

@@ -1,3 +1,6 @@
+import { Repository } from 'typeorm';
+import { User } from 'src/entities/user.entity';
+import { CreateUserDto } from 'src/dtos/create-user.dto';
 import { CreateEmailTemplateDto } from 'src/dtos/create-email-template.dto';
 import { CreateSmsTemplateDto } from 'src/dtos/create-sms-template.dto';
 import { SignUpDto } from 'src/dtos/sign-up.dto';
@@ -65,12 +68,44 @@ export enum SettingLevel {
   InternalUser = "internal-user"
 }
 
+export type SettingControlType =
+  | 'shortText'
+  | 'longText'
+  | 'numeric'
+  | 'boolean'
+  | 'date'
+  | 'datetime'
+  | 'mediaSingle'
+  | 'selectionStatic'
+  | 'custom';
+
+export interface SettingOption {
+  label: string;
+  value: string | number | boolean;
+}
+
 export interface SettingDefinition<T = any> {
   moduleName: string;
   key: string;
   value: T;
   level: SettingLevel;
   encrypted?: boolean;
+  label?: string;
+  description?: string;
+  placeholder?: string;
+  group?: string;
+  sortOrder?: number;
+  controlType?: SettingControlType;
+  options?: SettingOption[];
+  settingsWidget?: string; // for custom controlType, specify the frontend widget to use
+}
+
+export interface AdminSettingDefinition<T = any> extends SettingDefinition<T> {
+  editable: boolean;
+}
+
+export interface AdminSettingsResponse<T = any> {
+  data: AdminSettingDefinition<T>[];
 }
 
 // solid-core/settings/settings-provider.interface.ts
@@ -197,6 +232,12 @@ export class EventDetails<T> {
   ) { }
 }
 
+export interface IExtensionUserCreationProvider<T extends User = User, TDto extends CreateUserDto = CreateUserDto> {
+  readonly repo: Repository<T>;
+  buildExtensionEntity(dto: TDto): Promise<T>;
+  roles(dto: TDto): string[];
+}
+
 export interface IMail<TResponse = unknown> {
   sendEmail(
     to: string,
@@ -410,4 +451,3 @@ export interface AuditQueuePayload {
     userId?: number | null;
 }
 
-

package/src/jobs/database/api-email-subscriber-database.service.ts

@@ -27,6 +27,6 @@ export class ApiEmailQueueSubscriberDatabase extends DatabaseSubscriber<any> {
     }
 
     subscribe(message: QueueMessage<any>) {
-        this.emailService.sendEmailSynchronously(message);
+        return this.emailService.sendEmailSynchronously(message);
     }
 }

package/src/jobs/database/msg91-whatsapp-subscriber-database.service.ts

@@ -27,6 +27,6 @@ export class Msg91WhatsappQueueSubscriberDatabase extends DatabaseSubscriber<any
     }
 
     subscribe(message: QueueMessage<any>) {
-        this.whatsappService.sendWhatsAppMessageSynchronously(message);
+        return this.whatsappService.sendWhatsAppMessageSynchronously(message);
     }
 }

package/src/jobs/database/three60-whatsapp-subscriber-database.service.ts

@@ -27,6 +27,6 @@ export class Three60WhatsappQueueSubscriberDatabase extends DatabaseSubscriber<a
     }
 
     subscribe(message: QueueMessage<any>) {
-        this.whatsappService.sendWhatsAppMessageSynchronously(message);
+        return this.whatsappService.sendWhatsAppMessageSynchronously(message);
     }
 }