@solidxai/core 0.0.2

package/src/index.ts

@@ -0,0 +1,318 @@
+export * from './commands/helper'
+export * from './commands/refresh-model.command'
+export * from './commands/refresh-module.command'
+export * from './commands/remove-fields.command'
+export * from './commands/seed.command'
+export * from './commands/test-data.command'
+
+export * from './config/cache.options'
+
+export * from './decorators/active-user.decorator'
+export * from './decorators/solid-request-context.decorator'
+export * from './decorators/auth.decorator'
+export * from './decorators/computed-field-provider.decorator'
+export * from './decorators/scheduled-job-provider.decorator'
+export * from './decorators/is-not-in-enum.decorator'
+export * from './decorators/protocol.decorator'
+export * from './decorators/public.decorator'
+export * from './decorators/roles.decorator'
+export * from './decorators/selection-provider.decorator'
+export * from './decorators/error-codes-provider.decorator'
+export * from './decorators/solid-database-module.decorator'
+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'
+export * from './dtos/basic-filters.dto'
+export * from './dtos/solid-request-context.dto'
+export * from './dtos/change-password.dto'
+export * from './dtos/confirm-forgot-password.dto'
+export * from './dtos/create-action-metadata.dto'
+export * from './dtos/create-email-attachment.dto'
+export * from './dtos/create-email-template.dto'
+export * from './dtos/create-field-metadata.dto'
+export * from './dtos/create-list-of-values.dto'
+export * from './dtos/create-media-storage-provider-metadata.dto'
+export * from './dtos/create-media.dto'
+export * from './dtos/create-menu-item-metadata.dto'
+export * from './dtos/create-message.dto'
+export * from './dtos/create-model-metadata.dto'
+export * from './dtos/create-module-metadata.dto'
+export * from './dtos/create-mq-message-queue.dto'
+export * from './dtos/create-mq-message.dto'
+export * from './dtos/create-scheduled-job.dto'
+export * from './dtos/create-permission-metadata.dto'
+export * from './dtos/create-role-metadata.dto'
+export * from './dtos/create-short-url.dto'
+export * from './dtos/create-sms-template.dto'
+export * from './dtos/create-user.dto'
+export * from './dtos/create-view-metadata.dto'
+export * from './dtos/create-chatter-message.dto'
+export * from './dtos/create-chatter-message-details.dto'
+export * from './dtos/create-locale.dto'
+export * from './dtos/fetch-roles.dto'
+export * from './dtos/initiate-forgot-password.dto'
+export * from './dtos/mutate-role-permissions.dto'
+export * from './dtos/mutate-user-roles-list.dto'
+export * from './dtos/mutate-user-roles.dto'
+export * from './dtos/oauth-user-dto'
+export * from './dtos/otp-confirm-otp.dto'
+export * from './dtos/otp-sign-in.dto'
+export * from './dtos/otp-sign-up.dto'
+export * from './dtos/pagination-query.dto'
+export * from './dtos/query.dto'
+export * from './dtos/refresh-token.dto'
+export * from './dtos/register-private.dto'
+export * from './dtos/selection-dynamic-query.dto'
+export * from './dtos/sign-in.dto'
+export * from './dtos/sign-up.dto'
+export * from './dtos/sort-filter.dto'
+export * from './dtos/update-action-metadata.dto'
+export * from './dtos/update-email-template.dto'
+export * from './dtos/update-field-metadata.dto'
+export * from './dtos/update-media-storage-provider.dto'
+export * from './dtos/update-media.dto'
+export * from './dtos/update-menu-item-metadata.dto'
+export * from './dtos/update-message.dto'
+export * from './dtos/update-model-metadata.dto'
+export * from './dtos/update-module-metadata.dto'
+export * from './dtos/update-mq-message-queue.dto'
+export * from './dtos/update-mq-message.dto'
+export * from './dtos/update-scheduled-job.dto'
+export * from './dtos/update-permission-metadata.dto'
+export * from './dtos/update-role-metadata.dto'
+export * from './dtos/update-sms-template.dto'
+export * from './dtos/update-user.dto'
+export * from './dtos/update-view-metadata.dto'
+export * from './dtos/create-setting.dto'
+export * from './dtos/update-setting.dto'
+export * from './dtos/create-security-rule.dto'
+export * from './dtos/update-security-rule.dto'
+export * from './dtos/update-chatter-message.dto'
+export * from './dtos/update-chatter-message-details.dto'
+export * from './dtos/update-locale.dto'
+export * from './dtos/create-user-activity-history.dto'
+export * from './dtos/update-user-activity-history.dto'
+
+export * from './entities/action-metadata.entity'
+export * from './entities/common.entity'
+export * from './entities/legacy-common.entity'
+export * from './entities/legacy-common-with-id.entity'
+export * from './entities/email-attachment.entity'
+export * from './entities/email-template.entity'
+export * from './entities/field-metadata.entity'
+export * from './entities/list-of-values.entity'
+export * from './entities/media.entity'
+export * from './entities/media-storage-provider-metadata.entity'
+export * from './entities/menu-item-metadata.entity'
+export * from './entities/model-metadata.entity'
+export * from './entities/module-metadata.entity'
+export * from './entities/mq-message-queue.entity'
+export * from './entities/mq-message.entity'
+export * from './entities/scheduled-job.entity'
+export * from './entities/permission-metadata.entity'
+export * from './entities/role-metadata.entity'
+export * from './entities/sms-template.entity'
+export * from './entities/user.entity'
+export * from './entities/view-metadata.entity'
+export * from './entities/setting.entity'
+export * from './entities/saved-filters.entity'
+export * from './entities/user-view-metadata.entity'
+export * from './entities/security-rule.entity'
+export * from './entities/saved-filters.entity'
+export * from './entities/chatter-message.entity'
+export * from './entities/chatter-message-details.entity'
+export * from './entities/export-template.entity'
+export * from './entities/export-transaction.entity'
+export * from './entities/import-transaction.entity'
+export * from './entities/import-transaction-error-log.entity'
+export * from './entities/locale.entity'
+export * from './entities/user-activity-history.entity'
+export * from './entities/dashboard.entity'
+export * from './entities/dashboard-variable.entity'
+export * from './entities/dashboard-question.entity'
+export * from './entities/dashboard-question-sql-dataset-config.entity'
+export * from './entities/ai-interaction.entity'
+export * from './entities/model-sequence.entity'
+
+export * from './enums/auth-type.enum'
+export * from './decorators/disallow-in-production.decorator'
+
+export * from './filters/http-exception.filter'
+
+export * from './guards/access-token.guard'
+export * from './guards/authentication.guard'
+export * from './guards/permissions.guard'
+export * from './guards/roles.guard'
+
+export * from './helpers/command.service'
+export * from './helpers/module.helper'
+export * from './helpers/schematic.service'
+export * from './helpers/solid-registry'
+export * from './helpers/field-crud-managers/BigIntFieldCrudManager' //rename
+export * from './helpers/field-crud-managers/BooleanFieldCrudManager' //rename
+export * from './helpers/field-crud-managers/ComputedFieldCrudManager' //rename
+export * from './helpers/field-crud-managers/DateFieldCrudManager' //rename
+export * from './helpers/field-crud-managers/DecimalFieldCrudManager' //rename
+export * from './helpers/field-crud-managers/EmailFieldCrudManager' //rename
+export * from './helpers/field-crud-managers/IntFieldCrudManager' //rename
+export * from './helpers/field-crud-managers/JsonFieldCrudManager' //rename
+export * from './helpers/field-crud-managers/LongTextFieldCrudManager' //rename
+export * from './helpers/field-crud-managers/ManyToManyRelationFieldCrudManager' //rename
+export * from './helpers/field-crud-managers/ManyToOneRelationFieldCrudManager' //rename
+export * from './helpers/field-crud-managers/MediaFieldCrudManager' // Need to resolve ambiguity
+export * from './helpers/field-crud-managers/NoOpsFieldCrudManager' //rename
+export * from './helpers/field-crud-managers/OneToManyRelationFieldCrudManager' //rename
+export * from './helpers/field-crud-managers/PasswordFieldCrudManager' //rename
+export * from './helpers/field-crud-managers/RichTextFieldCrudManager' //rename
+export * from './helpers/field-crud-managers/SelectionDynamicFieldCrudManager' //rename
+export * from './helpers/field-crud-managers/SelectionStaticFieldCrudManager' //rename
+export * from './helpers/field-crud-managers/ShortTextFieldCrudManager' //rename
+export * from './helpers/field-crud-managers/UUIDFieldCrudManager' //rename
+export * from './helpers/environment.helper'
+export * from './helpers/cors.helper'
+export * from './helpers/security.helper'
+export * from './helpers/model-metadata-helper.service'
+export * from './helpers/image-encoding.helper'
+export * from './helpers/solid-microservice-adapter.service'
+
+export * from './services/crud.service'
+export * from './interceptors/logging.interceptor'
+export * from './interceptors/wrap-response.interceptor'
+
+export * from './interfaces/active-user-data.interface'
+export * from './interfaces/mq'
+export * from './services/scheduled-jobs/scheduled-job.interface';
+export * from './services/scheduled-jobs/scheduler.interface';
+export * from './services/scheduled-jobs/scheduler.service';
+
+export * from './jobs/api-email-publisher.service'
+export * from './jobs/api-email-queue-options'
+export * from './jobs/api-email-subscriber.service'
+export { SmtpEmailQueuePublisherRabbitmq, SmtpEmailQueuePublisherRabbitmq as EmailQueuePublisher } from './jobs/smtp-email-publisher.service' // alias for backward compatibility
+export * from './jobs/smtp-email-queue-options'
+export { SmtpEmailQueueSubscriberRabbitmq, SmtpEmailQueueSubscriberRabbitmq as EmailQueueSubscriber } from './jobs/smtp-email-subscriber.service' // alias for backward compatibility
+export * from './jobs/msg91-otp-publisher.service'
+export * from './jobs/msg91-otp-queue-options'
+export * from './jobs/msg91-otp-subscriber.service'
+export * from './jobs/msg91-sms-publisher.service'
+export * from './jobs/msg91-sms-queue-options'
+export * from './jobs/msg91-sms-subscriber.service'
+export * from './jobs/msg91-whatsapp-publisher.service'
+export * from './jobs/msg91-whatsapp-queue-options'
+export * from './jobs/msg91-whatsapp-subscriber.service'
+
+export * from './listeners/user-registration.listener'
+
+export * from './passport-strategies/google-oauth.strategy'
+export * from './passport-strategies/local.strategy'
+
+export * from './services/selection-providers/list-of-values-selection-providers.service'
+
+// seed-data
+export * from './seeders/email-template-seeder.service'
+export * from './seeders/permission-metadata-seeder.service'
+export * from './seeders/sms-template-seeder.service'
+export * from './seeders/module-metadata-seeder.service'
+export * from './seeders/user-seeder.service'
+
+// export * from './services/access-token-storage.service'
+export * from './services/action-metadata.service'
+export * from './services/authentication.service'
+export * from './services/bcrypt.service'
+export * from './services/computed-fields/uuid-external-id-computed-field-provider.service'
+export * from './services/crud-helper.service'
+export * from './services/crud.service'
+export * from './services/email-template.service'
+export * from './services/field-metadata.service'
+export * from './services/file'
+export * from './services/textract.service'
+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.service'
+export * from './services/media.service'
+export * from './services/mediaStorageProviders/file-s3-storage-provider'
+export * from './services/mediaStorageProviders/file-storage-provider'
+export * from './services/mediaStorageProviders/index'
+export * from './services/menu-item-metadata.service'
+export * from './services/model-metadata.service'
+export * from './services/module-metadata.service'
+export * from './services/mq-message-queue.service'
+export * from './services/mq-message.service'
+export * from './services/scheduled-job.service'
+export * from './services/pdf.service'
+export * from './services/permission-metadata.service'
+export * from './services/queues/rabbitmq-publisher.service'
+export * from './services/queues/rabbitmq-subscriber.service'
+export * from './services/refresh-token-ids-storage.service'
+export * from './services/role-metadata.service'
+export * from './services/selection-providers/list-of-models-selection-provider.service'
+export * from './services/short-url/tiny-url.service'
+export * from './services/sms/Msg91BaseSMSService' //rename
+export * from './services/sms/Msg91OTPService' //rename
+export * from './services/sms/Msg91SMSService' //rename
+export * from './services/sms/TwilioSMSService' //rename
+export * from './services/poller.service'
+export * from './services/sms-template.service'
+export * from './services/solid-introspect.service'
+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'
+export * from './services/chatter-message-details.service'
+export * from './services/locale.service'
+export * from './services/user-activity-history.service'
+export * from './services/import-transaction.service'
+export * from './services/import-transaction-error-log.service'
+export * from './services/excel.service'
+export * from './services/csv.service'
+export * from './services/queues/publisher-factory.service'
+export * from './services/queues/database-publisher.service'
+export * from './services/queues/database-subscriber.service'
+export * from './services/ai-interaction.service'
+
+// Factories
+export * from './factories/mail.factory'
+export * from './factories/sms.factory'
+export * from './factories/whatsapp.factory'
+
+// Repositories
+export * from './repository/solid-base.repository'
+export * from './repository/security-rule.repository'
+export * from './repository/chatter-message.repository'
+export * from './repository/chatter-message-details.repository'
+
+
+//softDeleteAwareEventSubscriber.subscriber.ts
+export * from './subscribers/model-metadata.subscriber'
+export * from './subscribers/soft-delete-aware-event.subscriber' //rename
+export * from './subscribers/view-metadata.subscriber' //rename
+export * from './subscribers/audit.subscriber'
+
+
+
+export * from './transformers/array-transformer'
+export * from './transformers/boolean-transformer'
+export * from './transformers/integer-transformer'
+export { default as datetimeTransformer } from './transformers/datetime-transformer'
+export * from './transformers/typeorm/local-date-time-transformer'
+
+export * from './validators/is-parsable-int'
+
+export * from './constants'
+export * from './interfaces'
+export * from './solid-core.module'
+
+export * from './winston.logger'
+
+export { ERROR_MESSAGES } from './constants/error-messages'

package/src/interceptors/logging.interceptor.ts

@@ -0,0 +1,110 @@
+import {
+    CallHandler,
+    ExecutionContext,
+    Injectable,
+    NestInterceptor,
+} from '@nestjs/common';
+import { Logger } from 'winston';
+import { Inject } from '@nestjs/common';
+import { Observable } from 'rxjs';
+import { tap, catchError } from 'rxjs/operators';
+import { WINSTON_MODULE_NEST_PROVIDER, WINSTON_MODULE_PROVIDER } from 'nest-winston';
+
+export const HttpStatusCodeMessages = {
+    100: "Continue",
+    101: "Switching Protocols",
+    102: "Processing",
+    200: "OK",
+    201: "Created",
+    202: "Accepted",
+    203: "Non-Authoritative Information",
+    204: "No Content",
+    205: "Reset Content",
+    206: "Partial Content",
+    207: "Multi-Status",
+    208: "Already Reported",
+    226: "IM Used",
+    300: "Multiple Choices",
+    301: "Moved Permanently",
+    302: "Found",
+    303: "See Other",
+    304: "Not Modified",
+    305: "Use Proxy",
+    307: "Temporary Redirect",
+    308: "Permanent Redirect",
+    400: "Bad Request",
+    401: "Unauthorized",
+    402: "Payment Required",
+    403: "Forbidden",
+    404: "Not Found",
+    405: "Method Not Allowed",
+    406: "Not Acceptable",
+    407: "Proxy Authentication Required",
+    408: "Request Timeout",
+    409: "Conflict",
+    410: "Gone",
+    411: "Length Required",
+    412: "Precondition Failed",
+    413: "Payload Too Large",
+    414: "URI Too Long",
+    415: "Unsupported Media Type",
+    416: "Range Not Satisfiable",
+    417: "Expectation Failed",
+    418: "I'm a teapot",  // Uncommon, but part of the April Fools' joke (RFC 2324)
+    421: "Misdirected Request",
+    422: "Unprocessable Entity",
+    423: "Locked",
+    424: "Failed Dependency",
+    425: "Too Early",
+    426: "Upgrade Required",
+    428: "Precondition Required",
+    429: "Too Many Requests",
+    431: "Request Header Fields Too Large",
+    451: "Unavailable For Legal Reasons",
+    500: "Internal Server Error",
+    501: "Not Implemented",
+    502: "Bad Gateway",
+    503: "Service Unavailable",
+    504: "Gateway Timeout",
+    505: "HTTP Version Not Supported",
+    506: "Variant Also Negotiates",
+    507: "Insufficient Storage",
+    508: "Loop Detected",
+    510: "Not Extended",
+    511: "Network Authentication Required",
+};
+
+
+@Injectable()
+export class LoggingInterceptor implements NestInterceptor {
+
+    constructor(@Inject(WINSTON_MODULE_PROVIDER) private readonly logger: Logger) { }
+
+    intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
+        const req = context.switchToHttp().getRequest();
+        const res = context.switchToHttp().getResponse();
+        const { method, url } = req;
+        const startTime = Date.now();
+
+        // We will capture any error that occurs in the request lifecycle.
+        return next.handle().pipe(
+            tap(() => {
+                // If the request was successful, log the status code and time
+                const responseTime = Date.now() - startTime;
+                this.logger.info(
+                    `[${res.statusCode} ${HttpStatusCodeMessages[res.statusCode] || ''}] ${method} ${url} ${responseTime}ms`,
+                );
+            }),
+            catchError((err) => {
+                const status = err.status || res.statusCode || 500;
+                // If an error occurs, it is likely due to a guard rejecting the request
+                const responseTime = Date.now() - startTime;
+                this.logger.error(
+                    `[${status || 500} ${HttpStatusCodeMessages[status] || 'Internal Server Error'}] ${method} ${url} - ${err.message || 'Unknown error'} ${responseTime}ms`,
+                );
+                // Re-throw the error after logging it
+                throw err;
+            }),
+        );
+    }
+}

package/src/interceptors/wrap-response.interceptor.ts

@@ -0,0 +1,26 @@
+import {
+    CallHandler,
+    ExecutionContext,
+    Injectable,
+    Logger,
+    NestInterceptor,
+  } from '@nestjs/common';
+  import { Observable } from 'rxjs';
+  import { map } from 'rxjs/operators';
+  
+  @Injectable()
+  export class WrapResponseInterceptor implements NestInterceptor {
+  
+    private readonly logger = new Logger(WrapResponseInterceptor.name);
+  
+    intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
+      return next.handle().pipe(map(data => {
+        return {
+          statusCode: 200,
+          message: [],
+          error: "",
+          data, 
+        };
+      }));
+    }
+  }

package/src/interfaces/active-user-data.interface.ts

@@ -0,0 +1,31 @@
+
+export interface ActiveUserData {
+  /**
+   * The "subject" of the token. The value of this property is the user ID
+   * that granted this token.
+   */
+  sub: number;
+
+  /**
+   * The subject's (user) username.
+   */
+  username: string;
+
+  /**
+   * The subject's (user) email.
+   */
+  email: string;
+
+  /**
+   * The subject's (user) roles.
+   * These are part of the JWT token, we simply decode them.
+   */
+  roles: string[];
+
+  /**
+   * The subject's (user) permissions.
+   * These are not part of the JWT token, we query them from the database each time the access-token guard is run. 
+   * So basically each time an authenticated request is initiated, we end up loading all the users permissions.
+   */
+  permissions: string[];
+}

package/src/interfaces/mq.ts

@@ -0,0 +1,23 @@
+import { QueuesModuleOptions } from "../interfaces";
+
+export interface QueueMessage<T> {
+    messageId?: string;
+    payload: T;
+    parentEntityId?: any;
+    parentEntity?: string;
+    retryCount?: number;
+    retryInterval?: number;
+    currentRetry?: number;
+}
+
+export type QueueServiceRole = 'publisher' | 'subscriber' | 'both';
+
+export interface QueuePublisher<T> {
+    options(): QueuesModuleOptions;
+    publish(message: QueueMessage<T>): Promise<string>;
+}
+
+export interface QueueSubscriber<T> {
+    options(): QueuesModuleOptions;
+    subscribe(message: QueueMessage<T>): void;
+}