@forklaunch/core 0.19.5 → 1.0.2

package/lib/ttlCache.interface-DClm-lSa.d.ts

@@ -0,0 +1,133 @@
+/**
+ * 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>;
+    /**
+     * Puts a batch of records into the cache.
+     *
+     * @param {TtlCacheRecord<T>[]} cacheRecords - The cache records to put into the cache.
+     * @returns {Promise<void>} - A promise that resolves when the records are put into the cache.
+     */
+    putBatchRecords<T>(cacheRecords: TtlCacheRecord<T>[]): Promise<void>;
+    /**
+     * Enqueues a record into the cache.
+     *
+     * @param {string} cacheRecordKey - The key of the cache record to enqueue.
+     * @returns {Promise<void>} - A promise that resolves when the record is enqueued into the cache.
+     */
+    enqueueRecord<T>(queueName: string, cacheRecord: T): Promise<void>;
+    /**
+     *
+     * Enqueues a batch of records into the cache.
+     *
+     * @param {string[]} cacheRecordKeys - The keys of the cache records to enqueue.
+     * @returns {Promise<void>} - A promise that resolves when the records are enqueued into the cache.
+     */
+    enqueueBatchRecords<T>(queueName: string, cacheRecords: 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>;
+    /**
+     * Deletes a batch of records from the cache.
+     *
+     * @param {string[]} cacheRecordKeys - The keys of the cache records to delete.
+     * @returns {Promise<void>} - A promise that resolves when the records are deleted from the cache.
+     */
+    deleteBatchRecords(cacheRecordKeys: string[]): Promise<void>;
+    /**
+     * Dequeues a record from the cache.
+     *
+     * @param {string} cacheRecordKey - The key of the cache record to dequeue.
+     * @returns {Promise<void>} - A promise that resolves when the record is dequeued from the cache.
+     */
+    dequeueRecord<T>(queueName: string): Promise<T>;
+    /**
+     * Dequeues a batch of records from the cache.
+     *
+     * @param {string[]} cacheRecordKeys - The keys of the cache records to dequeue.
+     * @returns {Promise<void>} - A promise that resolves when the records are dequeued from the cache.
+     */
+    dequeueBatchRecords<T>(queueName: string, pageSize: number): Promise<T[]>;
+    /**
+     * 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>>;
+    /**
+     * Reads a batch of records from the cache.
+     *
+     * @param {string[] | string} cacheRecordKeysOrPrefix - The keys of the cache records to read or a prefix to match.
+     * @returns {Promise<TtlCacheRecord<T>[]>} - A promise that resolves with the cache records.
+     */
+    readBatchRecords<T>(cacheRecordKeysOrPrefix: string[] | 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>;
+    /**
+     * Peeks at a batch of records in the cache to check if they exist.
+     *
+     * @param {string[] | string} cacheRecordKeysOrPrefix - The keys of the cache records to peek at or a prefix to match.
+     * @returns {Promise<boolean[]>} - A promise that resolves with an array of booleans indicating if the records exist.
+     */
+    peekBatchRecords(cacheRecordKeysOrPrefix: string[] | string): Promise<boolean[]>;
+    /**
+     * Peeks at a record in the cache to check if it exists.
+     *
+     * @param {string} queueName - The name of the queue to peek at.
+     * @returns {Promise<T>} - A promise that resolves with the record.
+     */
+    peekQueueRecord<T>(queueName: string): Promise<T>;
+    /**
+     * Peeks at a batch of records in the cache to check if they exist.
+     *
+     * @param {string} queueName - The name of the queue to peek at.
+     * @returns {Promise<T[]>} - A promise that resolves with the records.
+     */
+    peekQueueRecords<T>(queueName: string, pageSize: number): Promise<T[]>;
+    /**
+     * 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[]>;
+}
+
+export type { TtlCache as T, TtlCacheRecord as a };

package/lib/ws/index.d.mts

@@ -1,6 +1,6 @@
 import { AsyncAPIObject } from '@asyncapi/parser/esm/spec-types/v3';
 import { AnySchemaValidator, IdiomaticSchema, SchemaValidator } from '@forklaunch/validator';
-import { S as StringOnlyObject } from '../apiDefinition.types-DnUkFmfT.mjs';
+import { S as StringOnlyObject } from '../apiDefinition.types-Br0fDuBQ.mjs';
 import '@forklaunch/common';
 import '@opentelemetry/api';
 import 'jose';

package/lib/ws/index.d.ts

@@ -1,6 +1,6 @@
 import { AsyncAPIObject } from '@asyncapi/parser/esm/spec-types/v3';
 import { AnySchemaValidator, IdiomaticSchema, SchemaValidator } from '@forklaunch/validator';
-import { S as StringOnlyObject } from '../apiDefinition.types-DnUkFmfT.js';
+import { S as StringOnlyObject } from '../apiDefinition.types-Br0fDuBQ.js';
 import '@forklaunch/common';
 import '@opentelemetry/api';
 import 'jose';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forklaunch/core",
-  "version": "0.19.5",
+  "version": "1.0.2",
   "description": "forklaunch-js core package. Contains useful building blocks.",
   "homepage": "https://github.com/forklaunch/forklaunch-js#readme",
   "bugs": {
@@ -78,8 +78,8 @@
   "dependencies": {
     "@asyncapi/parser": "^3.6.0",
     "@forklaunch/opentelemetry-instrumentation-hyper-express": "0.0.5",
-    "@mikro-orm/core": "7.0.4",
-    "@mikro-orm/mongodb": "7.0.4",
+    "@mikro-orm/core": "7.0.5",
+    "@mikro-orm/mongodb": "7.0.5",
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/api-logs": "^0.213.0",
     "@opentelemetry/exporter-logs-otlp-http": "^0.213.0",
@@ -105,8 +105,8 @@
     "redis": "^5.11.0",
     "uuid": "^13.0.0",
     "zod": "^4.3.6",
-    "@forklaunch/validator": "0.11.5",
-    "@forklaunch/common": "0.7.5"
+    "@forklaunch/validator": "1.0.2",
+    "@forklaunch/common": "1.0.2"
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",
@@ -115,7 +115,7 @@
     "@types/jest": "^30.0.0",
     "@types/qs": "^6.15.0",
     "@types/uuid": "^11.0.0",
-    "@typescript/native-preview": "7.0.0-dev.20260320.1",
+    "@typescript/native-preview": "7.0.0-dev.20260323.1",
     "globals": "^17.4.0",
     "jest": "^30.3.0",
     "jose": "6.1.3",
@@ -124,9 +124,9 @@
     "ts-jest": "^29.4.6",
     "ts-node": "^10.9.2",
     "tsup": "^8.5.1",
-    "typedoc": "^0.28.17",
-    "typescript": "^5.9.3",
-    "typescript-eslint": "^8.57.1"
+    "typedoc": "^0.28.18",
+    "typescript": "^6.0.2",
+    "typescript-eslint": "^8.57.2"
   },
   "scripts": {
     "build": "tsgo --noEmit && tsup ./src/cache/index.ts ./src/controllers/index.ts ./src/mappers/index.ts ./src/objectstore/index.ts ./src/persistence/index.ts ./src/http/index.ts ./src/services/index.ts ./src/environment/index.ts ./src/ws/index.ts --format cjs,esm --no-splitting --dts --tsconfig tsconfig.json --out-dir lib --clean --sourcemap",