@solidxai/core 0.1.9-beta.7 → 0.1.9

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

@@ -0,0 +1,113 @@
+import {
+  Controller,
+  Get,
+  Inject,
+  InternalServerErrorException,
+  Query,
+  Req,
+  Res,
+  UseGuards,
+} from "@nestjs/common";
+import { ApiQuery, ApiTags } from "@nestjs/swagger";
+import { Request, Response } from "express";
+import {
+  FacebookAuthConfiguration,
+  isFacebookOAuthConfigured,
+} from "../helpers/facebook-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 { FacebookOauthGuard } from "../passport-strategies/facebook-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/facebook")
+export class FacebookAuthenticationController {
+  constructor(
+    private readonly userService: UserService,
+    private readonly authService: AuthenticationService,
+    private readonly settingService: SettingService,
+  ) {}
+
+  private async getConfiguration(): Promise<FacebookAuthConfiguration> {
+    return {
+      clientID:
+        await this.settingService.getConfigValue<SolidCoreSetting>(
+          "FACEBOOK_CLIENT_ID",
+        ),
+      clientSecret: await this.settingService.getConfigValue<SolidCoreSetting>(
+        "FACEBOOK_CLIENT_SECRET",
+      ),
+      callbackURL: await this.settingService.getConfigValue<SolidCoreSetting>(
+        "FACEBOOK_CALLBACK_URL",
+      ),
+      redirectURL: await this.settingService.getConfigValue<SolidCoreSetting>(
+        "FACEBOOK_REDIRECT_URL",
+      ),
+    };
+  }
+
+  private async validateConfiguration() {
+    const config = await this.getConfiguration();
+    if (!isFacebookOAuthConfigured(config)) {
+      throw new InternalServerErrorException(
+        "Facebook OAuth is not configured",
+      );
+    }
+    return config;
+  }
+
+  @Public()
+  @UseGuards(FacebookOauthGuard)
+  @Get("connect")
+  async connect() {
+    await this.validateConfiguration();
+  }
+
+  @Public()
+  @Get("connect/callback")
+  @UseGuards(FacebookOauthGuard)
+  async facebookAuthCallback(@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/facebook/auth endpoint which will finally generate the JWT token.
+   * 
+   * @param accessCode 
+   * @returns 
+   */
+  @Public()
+  @Get('dummy-redirect')
+  async dummyFacebookAuthRedirect(@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 Facebook.
+   * 
+   * @param accessCode 
+   * @returns 
+   */
+  @Public()
+  @Get("authenticate")
+  @ApiQuery({ name: "accessCode", required: true, type: String })
+  async facebookAuth(@Query("accessCode") accessCode: string) {
+    await this.validateConfiguration();
+    return this.authService.signInUsingFacebook(accessCode);
+  }
+}

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

@@ -1,4 +1,4 @@
-import { Controller, Post, Body, Param, UploadedFiles, UseInterceptors, Put, Get, Query, Delete } from '@nestjs/common';
+import { Controller, Post, Body, Param, UploadedFiles, UseInterceptors, Put, Get, Query, Delete, Patch } from '@nestjs/common';
 import { AnyFilesInterceptor } from "@nestjs/platform-express";
 import { ApiBearerAuth, ApiForbiddenResponse, ApiQuery, ApiTags } from '@nestjs/swagger';
 import { MenuItemMetadataService } from '../services/menu-item-metadata.service';
@@ -17,23 +17,23 @@ export class MenuItemMetadataController {
   @ApiBearerAuth("jwt")
   @Post()
   @UseInterceptors(AnyFilesInterceptor())
-  create(@Body() createDto: CreateMenuItemMetadataDto, @UploadedFiles() files: Array<Express.Multer.File>,@SolidRequestContextDecorator() solidRequestContext:SolidRequestContextDto) {
-    return this.service.create(createDto, files,solidRequestContext);
+  create(@Body() createDto: CreateMenuItemMetadataDto, @UploadedFiles() files: Array<Express.Multer.File>, @SolidRequestContextDecorator() solidRequestContext: SolidRequestContextDto) {
+    return this.service.create(createDto, files, solidRequestContext);
   }
 
   @ApiBearerAuth("jwt")
   @Post('/bulk')
   @UseInterceptors(AnyFilesInterceptor())
-  insertMany(@Body() createDtos: CreateMenuItemMetadataDto[], @UploadedFiles() filesArray: Express.Multer.File[][] = [],@SolidRequestContextDecorator() solidRequestContext:SolidRequestContextDto) {
-    return this.service.insertMany(createDtos, filesArray,solidRequestContext);
+  insertMany(@Body() createDtos: CreateMenuItemMetadataDto[], @UploadedFiles() filesArray: Express.Multer.File[][] = [], @SolidRequestContextDecorator() solidRequestContext: SolidRequestContextDto) {
+    return this.service.insertMany(createDtos, filesArray, solidRequestContext);
   }
 
 
   @ApiBearerAuth("jwt")
   @Put(':id')
   @UseInterceptors(AnyFilesInterceptor())
-  update(@Param('id') id: number, @Body() updateDto: UpdateMenuItemMetadataDto, @UploadedFiles() files: Array<Express.Multer.File>,@SolidRequestContextDecorator() solidRequestContext:SolidRequestContextDto) {
-    return this.service.update(id, updateDto, files,false,solidRequestContext);
+  update(@Param('id') id: number, @Body() updateDto: UpdateMenuItemMetadataDto, @UploadedFiles() files: Array<Express.Multer.File>, @SolidRequestContextDecorator() solidRequestContext: SolidRequestContextDto) {
+    return this.service.update(id, updateDto, files, false, solidRequestContext);
   }
 
   @ApiBearerAuth("jwt")
@@ -48,8 +48,8 @@ export class MenuItemMetadataController {
   @ApiQuery({ name: 'populateMedia', required: false, type: Array })
   @ApiQuery({ name: 'filters', required: false, type: Array })
   @Get()
-  async findMany(@Query() query: any,@SolidRequestContextDecorator() solidRequestContext:SolidRequestContextDto) {
-    return this.service.find(query,solidRequestContext);
+  async findMany(@Query() query: any, @SolidRequestContextDecorator() solidRequestContext: SolidRequestContextDto) {
+    return this.service.find(query, solidRequestContext);
   }
 
   // /api/solid-menu-item/me
@@ -63,19 +63,25 @@ export class MenuItemMetadataController {
 
   @ApiBearerAuth("jwt")
   @Get(':id')
-  async findOne(@Param('id') id: string, @Query() query: any,@SolidRequestContextDecorator() solidRequestContext:SolidRequestContextDto) {
-    return this.service.findOne(+id, query,solidRequestContext);
+  async findOne(@Param('id') id: string, @Query() query: any, @SolidRequestContextDecorator() solidRequestContext: SolidRequestContextDto) {
+    return this.service.findOne(+id, query, solidRequestContext);
   }
 
   @Delete('/bulk')
-  async deleteMany(@Body() ids: number[],@SolidRequestContextDecorator() solidRequestContext:SolidRequestContextDto) {
-    return this.service.deleteMany(ids,solidRequestContext);
+  async deleteMany(@Body() ids: number[], @SolidRequestContextDecorator() solidRequestContext: SolidRequestContextDto) {
+    return this.service.deleteMany(ids, solidRequestContext);
   }
 
   @ApiBearerAuth("jwt")
   @Delete(':id')
-  async delete(@Param('id') id: number,@SolidRequestContextDecorator() solidRequestContext:SolidRequestContextDto) {
-    return this.service.delete(id,solidRequestContext);
+  async delete(@Param('id') id: number, @SolidRequestContextDecorator() solidRequestContext: SolidRequestContextDto) {
+    return this.service.delete(id, solidRequestContext);
   }
 
+  @ApiBearerAuth('jwt')
+  @Patch(':id')
+  @UseInterceptors(AnyFilesInterceptor())
+  partialUpdate(@Param('id') id: number, @Body() updateDto: UpdateMenuItemMetadataDto, @UploadedFiles() files: Array<Express.Multer.File>) {
+    return this.service.update(id, updateDto, files, true);
+  }
 }

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/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/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/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;

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/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/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

@@ -261,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.ts

@@ -68,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
@@ -419,4 +451,3 @@ export interface AuditQueuePayload {
     userId?: number | null;
 }
 
-