forklaunch · RohinBhargava · Jul 9, 2024 · Jul 4, 2024 · Jul 7, 2024 · Jul 7, 2024
diff --git a/packages/core/.prettierignore b/packages/core/.prettierignore
@@ -0,0 +1,2 @@
+node_modules/
+dist/
diff --git a/packages/core/.prettierrc b/packages/core/.prettierrc
@@ -0,0 +1,6 @@
+{
+  "semi": true,
+  "trailingComma": "none",
+  "singleQuote": true,
+  "printWidth": 80
+}
diff --git a/packages/core/cache/index.ts b/packages/core/cache/index.ts
@@ -0,0 +1,3 @@
+export * from './interfaces/ttlCache.interface';
+export * from './redisTtlCache';
+export * from './types/ttlCacheRecord.types';
diff --git a/packages/core/cache/interfaces/ttlCache.interface.ts b/packages/core/cache/interfaces/ttlCache.interface.ts
@@ -1,53 +1,53 @@
-import { TtlCacheRecord } from "../types/ttlCacheRecord";
+import { TtlCacheRecord } from '../types/ttlCacheRecord.types';
 
 /**
  * Interface representing a TTL (Time-To-Live) cache.
  */
 export interface TtlCache {
-    /**
-     * Puts a record into the cache.
-     *
-     * @param {TtlCacheRecord} cacheRecord - The cache record to put into the cache.
-     * @returns {Promise<void>} - A promise that resolves when the record is put into the cache.
-     */
-    putRecord(cacheRecord: TtlCacheRecord): Promise<void>;
+  /**
+   * Puts a record into the cache.
+   *
+   * @param {TtlCacheRecord} cacheRecord - The cache record to put into the cache.
+   * @returns {Promise<void>} - A promise that resolves when the record is put into the cache.
+   */
+  putRecord(cacheRecord: TtlCacheRecord): Promise<void>;
 
-    /**
-     * Deletes a record from the cache.
-     *
-     * @param {string} cacheRecordKey - The key of the cache record to delete.
-     * @returns {Promise<void>} - A promise that resolves when the record is deleted from the cache.
-     */
-    deleteRecord(cacheRecordKey: string): Promise<void>;
+  /**
+   * Deletes a record from the cache.
+   *
+   * @param {string} cacheRecordKey - The key of the cache record to delete.
+   * @returns {Promise<void>} - A promise that resolves when the record is deleted from the cache.
+   */
+  deleteRecord(cacheRecordKey: string): Promise<void>;
 
-    /**
-     * Reads a record from the cache.
-     *
-     * @param {string} cacheRecordKey - The key of the cache record to read.
-     * @returns {Promise<TtlCacheRecord>} - A promise that resolves with the cache record.
-     */
-    readRecord(cacheRecordKey: string): Promise<TtlCacheRecord>;
+  /**
+   * Reads a record from the cache.
+   *
+   * @param {string} cacheRecordKey - The key of the cache record to read.
+   * @returns {Promise<TtlCacheRecord>} - A promise that resolves with the cache record.
+   */
+  readRecord(cacheRecordKey: string): Promise<TtlCacheRecord>;
 
-    /**
-     * Peeks at a record in the cache to check if it exists.
-     *
-     * @param {string} cacheRecordKey - The key of the cache record to peek at.
-     * @returns {Promise<boolean>} - A promise that resolves with a boolean indicating if the record exists.
-     */
-    peekRecord(cacheRecordKey: string): Promise<boolean>;
+  /**
+   * Peeks at a record in the cache to check if it exists.
+   *
+   * @param {string} cacheRecordKey - The key of the cache record to peek at.
+   * @returns {Promise<boolean>} - A promise that resolves with a boolean indicating if the record exists.
+   */
+  peekRecord(cacheRecordKey: string): Promise<boolean>;
 
-    /**
-     * Gets the TTL (Time-To-Live) in milliseconds.
-     *
-     * @returns {number} - The TTL in milliseconds.
-     */
-    getTtlMilliseconds(): number;
+  /**
+   * Gets the TTL (Time-To-Live) in milliseconds.
+   *
+   * @returns {number} - The TTL in milliseconds.
+   */
+  getTtlMilliseconds(): number;
 
-    /**
-     * Lists the keys in the cache that match a pattern prefix.
-     *
-     * @param {string} pattern_prefix - The pattern prefix to match.
-     * @returns {Promise<string[]>} - A promise that resolves with an array of keys matching the pattern prefix.
-     */
-    listKeys(pattern_prefix: string): Promise<string[]>;
+  /**
+   * Lists the keys in the cache that match a pattern prefix.
+   *
+   * @param {string} pattern_prefix - The pattern prefix to match.
+   * @returns {Promise<string[]>} - A promise that resolves with an array of keys matching the pattern prefix.
+   */
+  listKeys(pattern_prefix: string): Promise<string[]>;
 }
diff --git a/packages/core/cache/redisTtlCache.ts b/packages/core/cache/redisTtlCache.ts
@@ -1,6 +1,6 @@
-import { createClient } from 'redis';
+import { RedisClientOptions, createClient } from 'redis';
 import { TtlCache } from './interfaces/ttlCache.interface';
-import { TtlCacheRecord } from './types/ttlCacheRecord';
+import { TtlCacheRecord } from './types/ttlCacheRecord.types';
 
 /**
  * Class representing a Redis-based TTL (Time-To-Live) cache.
@@ -11,37 +11,42 @@ export class RedisTtlCache implements TtlCache {
 
   /**
    * Creates an instance of RedisTtlCache.
-   * 
+   *
    * @param {number} ttlMilliseconds - The default TTL in milliseconds.
    */
-  constructor(private ttlMilliseconds: number) {
+  constructor(
+    private ttlMilliseconds: number,
+    hostingOptions?: RedisClientOptions
+  ) {
     // Connects to localhost:6379 by default
     // url usage: redis[s]://[[username][:password]@][host][:port][/db-number]
-    this.client = createClient({
-        url: process.env.REDIS_URL
-    });
+    this.client = createClient(hostingOptions);
     this.client.on('error', (err) => console.log('Redis Client Error', err));
     this.client.on('connect', () => {
-      console.log('\x1b[32m%s\x1b[0m', 'Successfully Connected to Redis');  // Green text
+      console.log('\x1b[32m%s\x1b[0m', 'Successfully Connected to Redis'); // Green text
     });
     this.client.connect().catch(console.error);
   }
 
   /**
    * Puts a record into the Redis cache.
-   * 
+   *
    * @param {TtlCacheRecord} param0 - The cache record to put into the cache.
    * @returns {Promise<void>} - A promise that resolves when the record is put into the cache.
    */
-  async putRecord({ key, value, ttlMilliseconds = this.ttlMilliseconds }: TtlCacheRecord): Promise<void> {
+  async putRecord({
+    key,
+    value,
+    ttlMilliseconds = this.ttlMilliseconds
+  }: TtlCacheRecord): Promise<void> {
     await this.client.set(key, JSON.stringify(value), {
       PX: ttlMilliseconds
     });
   }
 
   /**
    * Deletes a record from the Redis cache.
-   * 
+   *
    * @param {string} cacheRecordKey - The key of the cache record to delete.
    * @returns {Promise<void>} - A promise that resolves when the record is deleted from the cache.
    */
@@ -51,7 +56,7 @@ export class RedisTtlCache implements TtlCache {
 
   /**
    * Reads a record from the Redis cache.
-   * 
+   *
    * @param {string} cacheRecordKey - The key of the cache record to read.
    * @returns {Promise<TtlCacheRecord>} - A promise that resolves with the cache record.
    * @throws {Error} - Throws an error if the record is not found.
@@ -66,12 +71,12 @@ export class RedisTtlCache implements TtlCache {
       key: cacheRecordKey,
       value: JSON.parse(value),
       ttlMilliseconds: ttl * 1000
-    }; 
+    };
   }
 
   /**
    * Lists the keys in the Redis cache that match a pattern prefix.
-   * 
+   *
    * @param {string} pattern_prefix - The pattern prefix to match.
    * @returns {Promise<string[]>} - A promise that resolves with an array of keys matching the pattern prefix.
    */
@@ -82,7 +87,7 @@ export class RedisTtlCache implements TtlCache {
 
   /**
    * Peeks at a record in the Redis cache to check if it exists.
-   * 
+   *
    * @param {string} cacheRecordKey - The key of the cache record to peek at.
    * @returns {Promise<boolean>} - A promise that resolves with a boolean indicating if the record exists.
    */
@@ -93,7 +98,7 @@ export class RedisTtlCache implements TtlCache {
 
   /**
    * Disconnects the Redis client.
-   * 
+   *
    * @returns {Promise<void>} - A promise that resolves when the client is disconnected.
    */
   async disconnect(): Promise<void> {
@@ -102,7 +107,7 @@ export class RedisTtlCache implements TtlCache {
 
   /**
    * Gets the default TTL (Time-To-Live) in milliseconds.
-   * 
+   *
    * @returns {number} - The TTL in milliseconds.
    */
   getTtlMilliseconds(): number {

diff --git a/packages/core/cache/types/ttlCacheRecord.ts → .../core/cache/types/ttlCacheRecord.types.ts b/packages/core/cache/types/ttlCacheRecord.ts → .../core/cache/types/ttlCacheRecord.types.ts
@@ -7,7 +7,7 @@
  * @property {number} ttlMilliseconds - The time-to-live of the cache record in milliseconds.
  */
 export type TtlCacheRecord = {
-    key: string;
-    value: unknown;
-    ttlMilliseconds: number;
+  key: string;
+  value: unknown;
+  ttlMilliseconds: number;
 };
diff --git a/packages/core/controllers/index.ts b/packages/core/controllers/index.ts
@@ -0,0 +1 @@
+export * from './interfaces/controller.interface';
diff --git a/packages/core/controllers/interfaces/controller.interface.ts b/packages/core/controllers/interfaces/controller.interface.ts
@@ -1,16 +1,16 @@
 /**
  * Interface representing a controller.
- * 
+ *
  * @interface Controller
  */
 interface Controller {
-    /**
-     * The base path for the controller.
-     * 
-     * @type {string}
-     * @readonly
-     */
-    readonly basePath: string;
+  /**
+   * The base path for the controller.
+   *
+   * @type {string}
+   * @readonly
+   */
+  readonly basePath: string;
 }
 
 export default Controller;
diff --git a/packages/core/database/index.ts b/packages/core/database/index.ts
@@ -0,0 +1 @@
+export * from './mikro/models/entities/base.entity';
diff --git a/packages/core/database/mikro/models/entities/base.entity.ts b/packages/core/database/mikro/models/entities/base.entity.ts
@@ -1,30 +1,30 @@
 import { v4 } from 'uuid';
-import { PrimaryKey, Property } from "@mikro-orm/core";
+import { PrimaryKey, Property } from '@mikro-orm/core';
 
 /**
  * Abstract class representing a base entity.
  */
 export abstract class BaseEntity {
   /**
    * The unique identifier for the entity.
-   * 
+   *
    * @type {string}
    * @readonly
    */
-  @PrimaryKey({ type: "uuid" })
+  @PrimaryKey({ type: 'uuid' })
   id: string = v4();
 
   /**
    * The date when the entity was created.
-   * 
+   *
    * @type {Date}
    */
   @Property()
   createdAt: Date = new Date();
 
   /**
    * The date when the entity was last updated.
-   * 
+   *
    * @type {Date}
    * @readonly
    */

diff --git a/packages/core/entityMapper/index.ts b/packages/core/entityMapper/index.ts
@@ -0,0 +1,2 @@
+export * from './models/requestEntityMapper.model';
+export * from './models/responseEntityMapper.model';
diff --git a/packages/core/entityMapper/interfaces/entityMapper.interface.ts b/packages/core/entityMapper/interfaces/entityMapper.interface.ts
@@ -1,17 +1,17 @@
-import { AnySchemaValidator } from "@forklaunch/validator";
+import { AnySchemaValidator } from '@forklaunch/validator';
 
 /**
  * Interface representing a constructor for an entity mapper.
- * 
+ *
  * @template T - The type of the entity mapper.
  * @interface EntityMapperConstructor
  */
 export interface EntityMapperConstructor<T, SV extends AnySchemaValidator> {
-    /**
-     * Creates a new instance of the entity mapper.
-     * 
-     * @param {AnySchemaValidator} schemaValidator - The arguments to pass to the constructor.
-     * @returns {T} - A new instance of the entity mapper.
-     */
-    new (schemaValidator: SV): T;
-}
+  /**
+   * Creates a new instance of the entity mapper.
+   *
+   * @param {AnySchemaValidator} schemaValidator - The arguments to pass to the constructor.
+   * @returns {T} - A new instance of the entity mapper.
+   */
+  new (schemaValidator: SV): T;
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		export * from './interfaces/controller.interface';
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		export * from './mikro/models/entities/base.entity';
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		export * from './models/requestEntityMapper.model';
		export * from './models/responseEntityMapper.model';