@solidstarters/solid-core 1.2.0

package/src/solid-core.module.ts

@@ -0,0 +1,316 @@
+import { Global, Module } from '@nestjs/common';
+import { ConfigModule, ConfigService } from '@nestjs/config';
+import {
+  APP_GUARD,
+  APP_INTERCEPTOR,
+  DiscoveryService,
+  MetadataScanner,
+  Reflector,
+} from '@nestjs/core';
+import { MulterModule } from '@nestjs/platform-express';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { RemoveFieldsCommand } from './commands/remove-fields.command';
+import appBuilderConfig from './config/app-builder.config';
+import { FieldMetadataController } from './controllers/field-metadata.controller';
+import { MediaStorageProviderMetadataController } from './controllers/media-storage-provider-metadata.controller';
+import { ModelMetadataController } from './controllers/model-metadata.controller';
+import { ModuleMetadataController } from './controllers/module-metadata.controller';
+import { TestController } from './controllers/test.controller';
+import { FieldMetadata } from './entities/field-metadata.entity';
+import { ListOfValues } from './entities/list-of-values.entity';
+import { MediaStorageProviderMetadata } from './entities/media-storage-provider-metadata.entity';
+import { Media } from './entities/media.entity';
+import { ModelMetadata } from './entities/model-metadata.entity';
+import { ModuleMetadata } from './entities/module-metadata.entity';
+import { CommandService } from './helpers/command.service';
+import { SchematicService } from './helpers/schematic.service';
+import { ListOfValuesSelectionProvider } from './providers/list-of-values-selection-providers.service';
+import { ModuleMetadataSeederService } from './seeders/module-metadata-seeder.service';
+import { CrudHelperService } from './services/crud-helper.service';
+import { FieldMetadataService } from './services/field-metadata.service';
+import { ListOfValuesService } from './services/list-of-values.service';
+import { MediaStorageProviderMetadataSeederService } from './services/media-storage-provider-metadata-seeder.service';
+import { MediaStorageProviderMetadataService } from './services/media-storage-provider-metadata.service';
+import { MediaService } from './services/media.service';
+import { ModelMetadataService } from './services/model-metadata.service';
+import { ModuleMetadataService } from './services/module-metadata.service';
+import { SolidIntrospectService } from './services/solid-introspect.service';
+// import { ListOfComputedFieldProvider } from './providers/list-of-computed-field-provider.service';
+import { ServeStaticModule } from '@nestjs/serve-static';
+import { join } from 'path';
+import { RefreshModelCommand } from './commands/refresh-model.command';
+import { MediaController } from './controllers/media.controller';
+
+import { RefreshModuleCommand } from './commands/refresh-module.command';
+import { ModelSubscriber } from './subscribers/model.subscriber';
+
+import { ViewMetadataController } from './controllers/view-metadata.controller';
+import { ViewMetadata } from './entities/view-metadata.entity';
+import { ViewMetadataService } from './services/view-metadata.service';
+
+import { ActionMetadataController } from './controllers/action-metadata.controller';
+import { ActionMetadata } from './entities/action-metadata.entity';
+import { ActionMetadataService } from './services/action-metadata.service';
+
+import { HttpModule } from '@nestjs/axios';
+import { JwtModule } from '@nestjs/jwt';
+import { SeedCommand } from './commands/seed.command';
+import commonConfig from './config/common.config';
+import { iamConfig, jwtConfig } from './config/iam.config';
+import { AuthenticationController } from './controllers/authentication.controller';
+import { EmailTemplateController } from './controllers/email-template.controller';
+import { GoogleAuthenticationController } from './controllers/google-authentication.controller';
+import { MenuItemMetadataController } from './controllers/menu-item-metadata.controller';
+import { MqMessageQueueController } from './controllers/mq-message-queue.controller';
+import { MqMessageController } from './controllers/mq-message.controller';
+import { OTPAuthenticationController } from './controllers/otp-authentication.controller';
+import { QueuesTestController } from './controllers/queues-test.controller';
+import { ServiceController } from './controllers/service.controller';
+import { SmsTemplateController } from './controllers/sms-template.controller';
+// import { UserController } from './controllers/user.controller';
+import { EmailAttachment } from './entities/email-attachment.entity';
+import { EmailTemplate } from './entities/email-template.entity';
+import { MenuItemMetadata } from './entities/menu-item-metadata.entity';
+import { MqMessageQueue } from './entities/mq-message-queue.entity';
+import { MqMessage } from './entities/mq-message.entity';
+import { SmsTemplate } from './entities/sms-template.entity';
+import { UserPasswordHistory } from './entities/user-password-history.entity';
+// import { User } from './entities/user.entity';
+import { AccessTokenGuard } from './guards/access-token.guard';
+import { AuthenticationGuard } from './guards/authentication.guard';
+import { PermissionsGuard } from './guards/permissions.guard';
+import { SolidRegistry } from './helpers/solid-registry';
+import { LoggingInterceptor } from './interceptors/logging.interceptor';
+import { ApiEmailQueuePublisher } from './jobs/api-email-publisher.service';
+import { ApiEmailQueueSubscriber } from './jobs/api-email-subscriber.service';
+import { EmailQueuePublisher } from './jobs/email-publisher.service';
+import { EmailQueueSubscriber } from './jobs/email-subscriber.service';
+import { OTPQueuePublisher } from './jobs/otp-publisher.service';
+import { OTPQueueSubscriber } from './jobs/otp-subscriber.service';
+import { TestQueuePublisher } from './jobs/queue-test-publisher.service';
+import { TestQueueSubscriber } from './jobs/queue-test-subscriber.service';
+import { SmsQueuePublisher } from './jobs/sms-publisher.service';
+import { SmsQueueSubscriber } from './jobs/sms-subscriber.service';
+import { WhatsappQueuePublisher } from './jobs/whatsapp-publisher.service';
+import { WhatsappQueueSubscriber } from './jobs/whatsapp-subscriber.service';
+import { UserRegistrationListener } from './listeners/user-registration.listener';
+import { GoogleOauthStrategy } from './passport-strategies/google-oauth.strategy';
+import { LocalStrategy } from './passport-strategies/local.strategy';
+import { EmailTemplateSeederService } from './seeders/email-template-seeder.service';
+import { SmsTemplateSeederService } from './seeders/sms-template-seeder.service';
+import { UserSeederService } from './seeders/user-seeder.service';
+import { AuthenticationService } from './services/authentication.service';
+import { BcryptService } from './services/bcrypt.service';
+import { UuidExternalIdComputedFieldProvider } from './services/computed-fields/uuid-external-id-computed-field-provider.service';
+import { EmailTemplateService } from './services/email-template.service';
+import { FileService } from './services/file.service';
+import { HashingService } from './services/hashing.service';
+import { ElasticEmailService } from './services/mail/ElasticEmailService';
+import { SMTPEMailService } from './services/mail/SMTPEmailService';
+import { MenuItemMetadataService } from './services/menu-item-metadata.service';
+import { MqMessageQueueService } from './services/mq-message-queue.service';
+import { MqMessageService } from './services/mq-message.service';
+import { PdfService } from './services/pdf.service';
+import { RefreshTokenIdsStorageService } from './services/refresh-token-ids-storage.service';
+import { ListOfModelsSelectionProvider } from './services/selection-providers/list-of-models-selection-provider.service';
+import { TinyUrlService } from './services/short-url/tiny-url.service';
+import { SmsTemplateService } from './services/sms-template.service';
+import { Msg91OTPService } from './services/sms/Msg91OTPService';
+import { Msg91SMSService } from './services/sms/Msg91SMSService';
+// import { UserService } from './services/user.service';
+import { Msg91WhatsappService } from './services/whatsapp/Msg91WhatsappService';
+import { SoftDeleteAwareEventSubscriber } from './subscribers/softDeleteAwareEventSubscriber.subscriber';
+
+import { PermissionMetadata } from './entities/permission-metadata.entity';
+import { PermissionMetadataService } from './services/permission-metadata.service';
+import { PermissionMetadataController } from './controllers/permission-metadata.controller';
+
+import { RoleMetadata } from './entities/role-metadata.entity';
+import { RoleMetadataService } from './services/role-metadata.service';
+import { RoleMetadataController } from './controllers/role-metadata.controller';
+import { PermissionMetadataSeederService } from './seeders/permission-metadata-seeder.service';
+import { User } from './entities/user.entity';
+import { UserService } from './services/user.service';
+import { UserController } from './controllers/user.controller';
+
+
+@Global()
+@Module({
+  imports: [
+    TypeOrmModule.forFeature([
+      ModelMetadata,
+      FieldMetadata,
+      ModuleMetadata,
+      ListOfValues,
+      MediaStorageProviderMetadata,
+      Media,
+      EmailTemplate,
+      SmsTemplate,
+      EmailAttachment,
+      User,
+      UserPasswordHistory,
+      ViewMetadata,
+      ActionMetadata,
+      MenuItemMetadata,
+      MqMessageQueue,
+      MqMessage,
+      PermissionMetadata,
+      RoleMetadata
+    ]),
+    ConfigModule.forFeature(appBuilderConfig),
+    ConfigModule.forFeature(commonConfig),
+    ConfigModule.forFeature(iamConfig),
+    ConfigModule.forFeature(jwtConfig),
+    JwtModule.registerAsync(jwtConfig.asProvider()),
+    ServeStaticModule.forRoot({
+      rootPath: join(process.cwd(), 'media-files-storage'),
+      serveRoot: '/media-files-storage',
+    }),
+    MulterModule.registerAsync({
+      imports: [ConfigModule],
+      useFactory: async (configService: ConfigService) => ({
+        dest: configService.get<string>('app-builder.uploadDir'),
+      }),
+      inject: [ConfigService],
+    }),
+    HttpModule,
+    ConfigModule,
+    // TypeOrmModule.forFeature([User]),
+  ],
+  controllers: [
+    ModuleMetadataController,
+    ModelMetadataController,
+    FieldMetadataController,
+    TestController,
+    MediaController,
+    MediaStorageProviderMetadataController,
+    ViewMetadataController,
+    ActionMetadataController,
+    MenuItemMetadataController,
+    ServiceController,
+    SmsTemplateController,
+    EmailTemplateController,
+    AuthenticationController,
+    GoogleAuthenticationController,
+    OTPAuthenticationController,
+    QueuesTestController,
+    MqMessageQueueController,
+    MqMessageController,
+    PermissionMetadataController,
+    RoleMetadataController,
+    UserController,
+  ],
+  providers: [
+    {
+      provide: APP_INTERCEPTOR,
+      useClass: LoggingInterceptor,
+    },
+    {
+      provide: HashingService,
+      useClass: BcryptService,
+    },
+    {
+      provide: APP_GUARD,
+      useClass: AuthenticationGuard,
+    },
+    {
+      provide: APP_GUARD,
+      useClass: PermissionsGuard,
+    },
+    ModuleMetadataService,
+    ModelMetadataService,
+    FieldMetadataService,
+    RemoveFieldsCommand,
+    RefreshModelCommand,
+    RefreshModuleCommand,
+    SolidIntrospectService,
+    DiscoveryService,
+    CrudHelperService,
+    Reflector,
+    MetadataScanner,
+    CommandService,
+    SchematicService,
+    MediaStorageProviderMetadataService,
+    MediaService,
+    MediaStorageProviderMetadataSeederService,
+    ModuleMetadataSeederService,
+    ListOfValuesService,
+    ListOfValuesSelectionProvider,
+    ModelSubscriber,
+    ViewMetadataService,
+    ActionMetadataService,
+    MenuItemMetadataService,
+    DiscoveryService,
+    Reflector,
+    MetadataScanner,
+    FileService,
+    SolidRegistry,
+    SeedCommand,
+    SMTPEMailService,
+    ElasticEmailService,
+    Msg91SMSService,
+    Msg91OTPService,
+    Msg91WhatsappService,
+    SmsTemplateService,
+    EmailTemplateService,
+    EmailQueuePublisher,
+    EmailQueueSubscriber,
+    ApiEmailQueuePublisher,
+    ApiEmailQueueSubscriber,
+    SmsQueuePublisher,
+    SmsQueueSubscriber,
+    OTPQueuePublisher,
+    OTPQueueSubscriber,
+    WhatsappQueuePublisher,
+    WhatsappQueueSubscriber,
+    EmailTemplateSeederService,
+    SmsTemplateSeederService,
+    TinyUrlService,
+    PdfService,
+    UuidExternalIdComputedFieldProvider,
+    ListOfModelsSelectionProvider,
+    SoftDeleteAwareEventSubscriber,
+    AccessTokenGuard,
+    AuthenticationService,
+    GoogleAuthenticationController,
+    RefreshTokenIdsStorageService,
+    UserSeederService,
+    LocalStrategy,
+    GoogleOauthStrategy,
+    UserRegistrationListener,
+    TestQueuePublisher,
+    TestQueueSubscriber,
+    MqMessageQueueService,
+    MqMessageService,
+    PermissionMetadataService,
+    RoleMetadataService,
+    PermissionMetadataSeederService,
+    UserService,
+  ],
+  exports: [
+    ModuleMetadataService,
+    ModelMetadataService,
+    FieldMetadataService,
+    MediaStorageProviderMetadataService,
+    MediaService,
+    DiscoveryService,
+    CrudHelperService,
+    MulterModule,
+    FileService,
+    SolidRegistry,
+    SMTPEMailService,
+    ElasticEmailService,
+    Msg91SMSService,
+    Msg91OTPService,
+    Msg91WhatsappService,
+    TinyUrlService,
+    PdfService,
+    EmailTemplateService,
+    SmsTemplateService,
+    UserSeederService,
+    AuthenticationService,
+    MqMessageQueueService,
+    MqMessageService,
+  ],
+})
+export class SolidCoreModule { }

package/src/subscribers/model.subscriber.ts

@@ -0,0 +1,76 @@
+import { DataSource, EntitySubscriberInterface, EventSubscriber, InsertEvent, UpdateEvent } from 'typeorm';
+import { ModelMetadata } from '../entities/model-metadata.entity';
+import { FieldMetadata } from '../entities/field-metadata.entity';
+import { Injectable, Logger, NotFoundException } from '@nestjs/common';
+import { InjectDataSource } from '@nestjs/typeorm';
+import { RemoveFieldsCommand } from '../commands/remove-fields.command';
+
+@EventSubscriber()
+@Injectable()
+export class ModelSubscriber implements EntitySubscriberInterface<ModelMetadata> {
+  private readonly logger = new Logger(ModelSubscriber.name);
+
+  constructor(
+    @InjectDataSource()
+    private readonly dataSource: DataSource,
+
+  ) {
+    this.dataSource.subscribers.push(this);
+  }
+
+  listenTo() {
+    return ModelMetadata;
+  }
+
+  async afterInsert(event: InsertEvent<ModelMetadata>): Promise<void> {
+    this.logger.debug(`[ModelSubscriber] getting invoked for insert on model: ${event.entity.singularName}`);
+
+    // const fieldMetadataRepo = event.manager.getRepository(FieldMetadata);
+    // const fieldMetadataRepo = this.dataSource.getRepository(FieldMetadata);
+    const transactionManager = event.queryRunner?.manager;
+    if (!transactionManager) {
+      throw new NotFoundException(`Trnasaction Manager not found`);
+
+    }
+
+    const systemFieldsMetadata = [
+      {
+        name: "id",
+        displayName: "Id",
+        type: "int",
+        ormType: "bigint",
+        isSystem: true,
+        model: event.entity,
+      },
+      {
+        name: "createdAt",
+        displayName: "Created At",
+        type: "datetime",
+        ormType: "timestamp",
+        isSystem: true,
+        model: event.entity,
+      },
+      {
+        name: "updatedAt",
+        displayName: "Updated At",
+        type: "datetime",
+        ormType: "timestamp",
+        isSystem: true,
+        model: event.entity,
+      },
+      {
+        name: "deletedAt",
+        displayName: "Deleted At",
+        type: "datetime",
+        ormType: "timestamp",
+        isSystem: true,
+        model: event.entity,
+      },
+    ];
+    transactionManager.save(FieldMetadata, systemFieldsMetadata);
+    // Save to the database.
+    // fieldMetadataRepo.save(systemFieldsMetadata);
+
+  }
+
+}

package/src/subscribers/softDeleteAwareEventSubscriber.subscriber.ts

@@ -0,0 +1,36 @@
+import { Injectable, Logger, NotFoundException } from "@nestjs/common";
+import { InjectDataSource } from "@nestjs/typeorm";
+import { DataSource, EntitySubscriberInterface, EventSubscriber, RecoverEvent, SoftRemoveEvent } from "typeorm";
+
+
+@EventSubscriber()
+@Injectable()
+export class SoftDeleteAwareEventSubscriber implements EntitySubscriberInterface {
+    private readonly logger = new Logger(SoftDeleteAwareEventSubscriber.name);
+    constructor(
+        @InjectDataSource()
+        private readonly dataSource: DataSource,
+    ) {
+        this.dataSource.subscribers.push(this);
+    }
+
+    beforeSoftRemove(event: SoftRemoveEvent<any>): Promise<any> | void {
+        if (!event.entity) return;
+        const entity = event.entity;
+        // Update trackerDate if deletedAt is not already set
+        if (!entity.deletedAt) {
+            entity.deletedTracker = `${new Date()}`; // Set trackerDate to the current date
+        } else {
+            entity.deletedTracker = `${entity.deletedAt}`; // Set trackerDate to the deleted Date
+        }
+        console.log('TrackerDate updated:', entity.trackerDate);
+
+    }
+
+    beforeRecover(event: RecoverEvent<any>): Promise<any> | void {
+        if (!event.entity) return;
+        const entity = event.entity;
+        entity.deletedTracker = "not-deleted"; // Set trackerDate to the current date
+    }
+
+}

package/src/transformers/array-transformer.ts

@@ -0,0 +1,16 @@
+// const integerTransformer = ({ value }: any) => {
+//     return Number(value)
+// }
+// export default integerTransformer
+
+const arrayTransformer = ({ value }: any) => {
+    if (value === null || value === undefined) return value;
+    const parsedValues = value.map(item => {
+        // if(Typeof ) 
+        const parsedItem = JSON.parse(item);
+        return parsedItem;
+    });
+    return parsedValues ?? parsedValues;
+};
+
+export default arrayTransformer;

package/src/transformers/boolean-transformer.ts

@@ -0,0 +1,12 @@
+import { TransformFnParams } from "class-transformer";
+
+const transformBoolean = ({ value }: TransformFnParams): boolean => {
+    if (typeof (value) === "boolean") {
+        return value
+    } else if (value === 'true') {
+        return true
+    } else {
+        return false
+    }
+};
+export default transformBoolean

package/src/transformers/integer-transformer.ts

@@ -0,0 +1,17 @@
+// const integerTransformer = ({ value }: any) => {
+//     return Number(value)
+// }
+// export default integerTransformer
+
+const integerTransformer = ({ value }: any) => {
+    // Ensure null or undefined values are returned as is
+    if (value === null || value === undefined) return value;
+
+    // Parse the value into an integer
+    const parsedValue = parseInt(value, 10);
+
+    // Return the parsed value if it's a valid number; otherwise, return null or throw an error
+    return isNaN(parsedValue) ? null : parsedValue;
+};
+
+export default integerTransformer;

package/src/validators/is-parsable-int.ts

@@ -0,0 +1,21 @@
+import { registerDecorator, ValidationOptions, ValidationArguments } from 'class-validator';
+
+export function IsParsableInt(validationOptions?: ValidationOptions) {
+    return function (object: Object, propertyName: string) {
+        registerDecorator({
+            name: 'isParsableInt',
+            target: object.constructor,
+            propertyName: propertyName,
+            options: validationOptions,
+            validator: {
+                validate(value: any, args: ValidationArguments) {
+                    const parsedValue = parseInt(value, 10);
+                    return Number.isInteger(parsedValue);
+                },
+                defaultMessage() {
+                    return 'Value must be a parsable integer';
+                },
+            },
+        });
+    };
+}

package/src/workflow.readme.md

@@ -0,0 +1,25 @@
+# Workflow
+
+Let's say that:
+
+- Solid backend is located at: solid.website.com, and
+- Your app frontend is located at: website.com
+
+1. The user goes on your frontend app (https://website.com) and clicks on your button connect with Google.
+2. The frontend redirects the tab to the backend URL: https://solid.website.com/api/iam/google/connect.
+3. The backend redirects the tab to the Google login page where the user logs in.
+4. Once done, Google redirects the tab to the backend URL: https://solid.website.com/api/iam/google/connect/callback. When this callback comes, it comes with the users profile & access token.
+5. Then, the backend redirects the tab to the url of your choice with the param accessCode (example: http://website.com/connect/google/dummy-redirect?accessCode=eyfvg).
+6. The frontend (http://website.com/connect/google/dummy-redirect) calls the backend with https://solid.website.com/api/iam/google/auth?accessCode=eyfvg that returns the Solid user profile with its jwt.
+   (Under the hood, the backend asks Google for the user's profile and a match is done on Google user's email address and Solid user's email address).
+7. The frontend now possesses the user's jwt, which means the user is connected and the frontend can make authenticated requests to the backend!
+
+
+# Useful links
+
+- https://medium.com/@flavtech/google-oauth2-authentication-with-nestjs-explained-ab585c53edec
+- https://docs.nestjs.com/recipes/passport
+
+
+ClientId: 210036511862-8mv1rt3s63qj0v8jj3t0gf0l04r1alek.apps.googleusercontent.com
+ClientSecret: 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

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+    "compilerOptions": {
+      "module": "commonjs",
+      "declaration": true,
+      "declarationMap": true,    // Maps declaration files to source files
+      "removeComments": true,
+      "emitDecoratorMetadata": true,
+      "experimentalDecorators": true,
+      "allowSyntheticDefaultImports": true,
+      "target": "ES2021",
+      "sourceMap": true,
+      "outDir": "./dist",
+      "baseUrl": "./",
+      "incremental": true,
+      "skipLibCheck": true,
+      "strictNullChecks": false,
+      "noImplicitAny": false,
+      "strictBindCallApply": false,
+      "forceConsistentCasingInFileNames": false,
+      "noFallthroughCasesInSwitch": false,
+      "esModuleInterop": true,
+      "resolveJsonModule": true,
+    }
+  }
+