@forklaunch/core 0.2.36 → 0.3.0

package/lib/{src/database/mikro/models/entities/base.entity.d.ts → base.entity-DNfmMOgd.d.mts}

@@ -1,7 +1,7 @@
 /**
  * Abstract class representing a base entity.
  */
-export declare abstract class BaseEntity {
+declare abstract class BaseEntity {
     /**
      * The unique identifier for the entity.
      *
@@ -23,4 +23,5 @@ export declare abstract class BaseEntity {
      */
     updatedAt: Date;
 }
-//# sourceMappingURL=base.entity.d.ts.map
+
+export { BaseEntity as B };

package/lib/base.entity-DNfmMOgd.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Abstract class representing a base entity.
+ */
+declare abstract class BaseEntity {
+    /**
+     * The unique identifier for the entity.
+     *
+     * @type {string}
+     * @readonly
+     */
+    id: string;
+    /**
+     * The date when the entity was created.
+     *
+     * @type {Date}
+     */
+    createdAt: Date;
+    /**
+     * The date when the entity was last updated.
+     *
+     * @type {Date}
+     * @readonly
+     */
+    updatedAt: Date;
+}
+
+export { BaseEntity as B };

package/lib/{src/cache/redisTtlCache.d.ts → cache/index.d.mts}

@@ -1,11 +1,71 @@
 import { RedisClientOptions } from 'redis';
-import { TtlCache } from './interfaces/ttlCache.interface';
-import { TtlCacheRecord } from './types/ttlCacheRecord.types';
+
+/**
+ * Type representing a TTL (Time-To-Live) cache record.
+ *
+ * @typedef {Object} TtlCacheRecord
+ * @property {string} key - The key of the cache record.
+ * @property {any} value - The value of the cache record.
+ * @property {number} ttlMilliseconds - The time-to-live of the cache record in milliseconds.
+ */
+type TtlCacheRecord<T> = {
+    key: string;
+    value: T;
+    ttlMilliseconds: number;
+};
+
+/**
+ * Interface representing a TTL (Time-To-Live) cache.
+ */
+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<T>(cacheRecord: TtlCacheRecord<T>): 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<T>(cacheRecordKey: string): Promise<TtlCacheRecord<T>>;
+    /**
+     * 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;
+    /**
+     * 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[]>;
+}
+
 /**
  * Class representing a Redis-based TTL (Time-To-Live) cache.
  * Implements the TtlCache interface.
  */
-export declare class RedisTtlCache implements TtlCache {
+declare class RedisTtlCache implements TtlCache {
     private ttlMilliseconds;
     private client;
     /**
@@ -64,4 +124,7 @@ export declare class RedisTtlCache implements TtlCache {
      */
     getTtlMilliseconds(): number;
 }
-//# sourceMappingURL=redisTtlCache.d.ts.map
+
+declare const createCacheKey: (cacheKeyPrefix: string) => (id: string) => string;
+
+export { RedisTtlCache, type TtlCache, type TtlCacheRecord, createCacheKey };

package/lib/cache/index.d.ts

@@ -0,0 +1,130 @@
+import { RedisClientOptions } from 'redis';
+
+/**
+ * Type representing a TTL (Time-To-Live) cache record.
+ *
+ * @typedef {Object} TtlCacheRecord
+ * @property {string} key - The key of the cache record.
+ * @property {any} value - The value of the cache record.
+ * @property {number} ttlMilliseconds - The time-to-live of the cache record in milliseconds.
+ */
+type TtlCacheRecord<T> = {
+    key: string;
+    value: T;
+    ttlMilliseconds: number;
+};
+
+/**
+ * Interface representing a TTL (Time-To-Live) cache.
+ */
+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<T>(cacheRecord: TtlCacheRecord<T>): 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<T>(cacheRecordKey: string): Promise<TtlCacheRecord<T>>;
+    /**
+     * 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;
+    /**
+     * 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[]>;
+}
+
+/**
+ * Class representing a Redis-based TTL (Time-To-Live) cache.
+ * Implements the TtlCache interface.
+ */
+declare class RedisTtlCache implements TtlCache {
+    private ttlMilliseconds;
+    private client;
+    /**
+     * Creates an instance of RedisTtlCache.
+     *
+     * @param {number} ttlMilliseconds - The default TTL in milliseconds.
+     * @param {RedisClientOptions} [hostingOptions] - The Redis client options.
+     */
+    constructor(ttlMilliseconds: number, hostingOptions?: RedisClientOptions);
+    /**
+     * 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.
+     */
+    putRecord<T>({ key, value, ttlMilliseconds }: TtlCacheRecord<T>): Promise<void>;
+    /**
+     * 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.
+     */
+    deleteRecord(cacheRecordKey: string): Promise<void>;
+    /**
+     * 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.
+     */
+    readRecord<T>(cacheRecordKey: string): Promise<TtlCacheRecord<T>>;
+    /**
+     * 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.
+     */
+    listKeys(pattern_prefix: string): Promise<string[]>;
+    /**
+     * 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.
+     */
+    peekRecord(cacheRecordKey: string): Promise<boolean>;
+    /**
+     * Disconnects the Redis client.
+     *
+     * @returns {Promise<void>} - A promise that resolves when the client is disconnected.
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Gets the default TTL (Time-To-Live) in milliseconds.
+     *
+     * @returns {number} - The TTL in milliseconds.
+     */
+    getTtlMilliseconds(): number;
+}
+
+declare const createCacheKey: (cacheKeyPrefix: string) => (id: string) => string;
+
+export { RedisTtlCache, type TtlCache, type TtlCacheRecord, createCacheKey };

package/lib/cache/index.js

@@ -0,0 +1,133 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/cache/index.ts
+var cache_exports = {};
+__export(cache_exports, {
+  RedisTtlCache: () => RedisTtlCache,
+  createCacheKey: () => createCacheKey
+});
+module.exports = __toCommonJS(cache_exports);
+
+// src/cache/redisTtlCache.ts
+var import_redis = require("redis");
+var RedisTtlCache = class {
+  /**
+   * Creates an instance of RedisTtlCache.
+   *
+   * @param {number} ttlMilliseconds - The default TTL in milliseconds.
+   * @param {RedisClientOptions} [hostingOptions] - The Redis client options.
+   */
+  constructor(ttlMilliseconds, hostingOptions) {
+    this.ttlMilliseconds = ttlMilliseconds;
+    this.client = (0, import_redis.createClient)(hostingOptions);
+    this.client.on("error", (err) => console.error("Redis Client Error", err));
+    this.client.connect().catch(console.error);
+  }
+  client;
+  /**
+   * 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
+  }) {
+    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.
+   */
+  async deleteRecord(cacheRecordKey) {
+    await this.client.del(cacheRecordKey);
+  }
+  /**
+   * 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.
+   */
+  async readRecord(cacheRecordKey) {
+    const value = await this.client.get(cacheRecordKey);
+    if (value === null) {
+      throw new Error(`Record not found for key: ${cacheRecordKey}`);
+    }
+    const ttl = await this.client.ttl(cacheRecordKey);
+    return {
+      key: cacheRecordKey,
+      value: JSON.parse(value),
+      ttlMilliseconds: ttl * 1e3
+    };
+  }
+  /**
+   * 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.
+   */
+  async listKeys(pattern_prefix) {
+    const keys = await this.client.keys(pattern_prefix + "*");
+    return keys;
+  }
+  /**
+   * 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.
+   */
+  async peekRecord(cacheRecordKey) {
+    const result = await this.client.exists(cacheRecordKey);
+    return result === 1;
+  }
+  /**
+   * Disconnects the Redis client.
+   *
+   * @returns {Promise<void>} - A promise that resolves when the client is disconnected.
+   */
+  async disconnect() {
+    await this.client.quit();
+  }
+  /**
+   * Gets the default TTL (Time-To-Live) in milliseconds.
+   *
+   * @returns {number} - The TTL in milliseconds.
+   */
+  getTtlMilliseconds() {
+    return this.ttlMilliseconds;
+  }
+};
+
+// src/cache/utils/cacheKey.ts
+var createCacheKey = (cacheKeyPrefix) => (id) => {
+  return `${cacheKeyPrefix}:${id}`;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  RedisTtlCache,
+  createCacheKey
+});

package/lib/cache/index.mjs

@@ -0,0 +1,105 @@
+// src/cache/redisTtlCache.ts
+import { createClient } from "redis";
+var RedisTtlCache = class {
+  /**
+   * Creates an instance of RedisTtlCache.
+   *
+   * @param {number} ttlMilliseconds - The default TTL in milliseconds.
+   * @param {RedisClientOptions} [hostingOptions] - The Redis client options.
+   */
+  constructor(ttlMilliseconds, hostingOptions) {
+    this.ttlMilliseconds = ttlMilliseconds;
+    this.client = createClient(hostingOptions);
+    this.client.on("error", (err) => console.error("Redis Client Error", err));
+    this.client.connect().catch(console.error);
+  }
+  client;
+  /**
+   * 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
+  }) {
+    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.
+   */
+  async deleteRecord(cacheRecordKey) {
+    await this.client.del(cacheRecordKey);
+  }
+  /**
+   * 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.
+   */
+  async readRecord(cacheRecordKey) {
+    const value = await this.client.get(cacheRecordKey);
+    if (value === null) {
+      throw new Error(`Record not found for key: ${cacheRecordKey}`);
+    }
+    const ttl = await this.client.ttl(cacheRecordKey);
+    return {
+      key: cacheRecordKey,
+      value: JSON.parse(value),
+      ttlMilliseconds: ttl * 1e3
+    };
+  }
+  /**
+   * 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.
+   */
+  async listKeys(pattern_prefix) {
+    const keys = await this.client.keys(pattern_prefix + "*");
+    return keys;
+  }
+  /**
+   * 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.
+   */
+  async peekRecord(cacheRecordKey) {
+    const result = await this.client.exists(cacheRecordKey);
+    return result === 1;
+  }
+  /**
+   * Disconnects the Redis client.
+   *
+   * @returns {Promise<void>} - A promise that resolves when the client is disconnected.
+   */
+  async disconnect() {
+    await this.client.quit();
+  }
+  /**
+   * Gets the default TTL (Time-To-Live) in milliseconds.
+   *
+   * @returns {number} - The TTL in milliseconds.
+   */
+  getTtlMilliseconds() {
+    return this.ttlMilliseconds;
+  }
+};
+
+// src/cache/utils/cacheKey.ts
+var createCacheKey = (cacheKeyPrefix) => (id) => {
+  return `${cacheKeyPrefix}:${id}`;
+};
+export {
+  RedisTtlCache,
+  createCacheKey
+};

package/lib/controllers/index.d.mts

@@ -0,0 +1,5 @@
+type Controller<Service> = {
+    [K in keyof Service]: unknown;
+};
+
+export type { Controller };

package/lib/controllers/index.d.ts

@@ -0,0 +1,5 @@
+type Controller<Service> = {
+    [K in keyof Service]: unknown;
+};
+
+export type { Controller };

package/lib/controllers/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/controllers/index.ts
+var controllers_exports = {};
+module.exports = __toCommonJS(controllers_exports);

package/lib/database/index.d.mts

@@ -0,0 +1,37 @@
+export { B as BaseEntity } from '../base.entity-DNfmMOgd.mjs';
+import { ObjectId } from '@mikro-orm/mongodb';
+
+/**
+ * Abstract class representing a base entity.
+ */
+declare abstract class MongoBaseEntity {
+    /**
+     * The serialized unique identifier for the entity.
+     *
+     * @type {string}
+     * @readonly
+     */
+    _id: ObjectId;
+    /**
+     * The unique identifier for the entity.
+     *
+     * @type {string}
+     * @readonly
+     */
+    id: string;
+    /**
+     * The date when the entity was created.
+     *
+     * @type {Date}
+     */
+    createdAt: Date;
+    /**
+     * The date when the entity was last updated.
+     *
+     * @type {Date}
+     * @readonly
+     */
+    updatedAt: Date;
+}
+
+export { MongoBaseEntity };

package/lib/{src/database/mikro/models/entities/mongo.base.entity.d.ts → database/index.d.ts}

@@ -1,8 +1,10 @@
+export { B as BaseEntity } from '../base.entity-DNfmMOgd.js';
 import { ObjectId } from '@mikro-orm/mongodb';
+
 /**
  * Abstract class representing a base entity.
  */
-export declare abstract class MongoBaseEntity {
+declare abstract class MongoBaseEntity {
     /**
      * The serialized unique identifier for the entity.
      *
@@ -31,4 +33,5 @@ export declare abstract class MongoBaseEntity {
      */
     updatedAt: Date;
 }
-//# sourceMappingURL=mongo.base.entity.d.ts.map
+
+export { MongoBaseEntity };

package/lib/database/index.js

@@ -0,0 +1,78 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __decorateClass = (decorators, target, key, kind) => {
+  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
+  for (var i = decorators.length - 1, decorator; i >= 0; i--)
+    if (decorator = decorators[i])
+      result = (kind ? decorator(target, key, result) : decorator(result)) || result;
+  if (kind && result) __defProp(target, key, result);
+  return result;
+};
+
+// src/database/index.ts
+var database_exports = {};
+__export(database_exports, {
+  BaseEntity: () => BaseEntity,
+  MongoBaseEntity: () => MongoBaseEntity
+});
+module.exports = __toCommonJS(database_exports);
+
+// src/database/mikro/models/entities/base.entity.ts
+var import_uuid = require("uuid");
+var import_core = require("@mikro-orm/core");
+var BaseEntity = class {
+  id = (0, import_uuid.v4)();
+  createdAt = /* @__PURE__ */ new Date();
+  updatedAt = /* @__PURE__ */ new Date();
+};
+__decorateClass([
+  (0, import_core.PrimaryKey)({ type: "uuid" })
+], BaseEntity.prototype, "id", 2);
+__decorateClass([
+  (0, import_core.Property)()
+], BaseEntity.prototype, "createdAt", 2);
+__decorateClass([
+  (0, import_core.Property)({ onUpdate: () => /* @__PURE__ */ new Date() })
+], BaseEntity.prototype, "updatedAt", 2);
+
+// src/database/mikro/models/entities/mongo.base.entity.ts
+var import_core2 = require("@mikro-orm/core");
+var MongoBaseEntity = class {
+  _id;
+  id;
+  createdAt = /* @__PURE__ */ new Date();
+  updatedAt = /* @__PURE__ */ new Date();
+};
+__decorateClass([
+  (0, import_core2.PrimaryKey)()
+], MongoBaseEntity.prototype, "_id", 2);
+__decorateClass([
+  (0, import_core2.SerializedPrimaryKey)()
+], MongoBaseEntity.prototype, "id", 2);
+__decorateClass([
+  (0, import_core2.Property)()
+], MongoBaseEntity.prototype, "createdAt", 2);
+__decorateClass([
+  (0, import_core2.Property)({ onUpdate: () => /* @__PURE__ */ new Date() })
+], MongoBaseEntity.prototype, "updatedAt", 2);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  BaseEntity,
+  MongoBaseEntity
+});