@decaf-ts/integrations 0.10.8 → 0.12.0

package/lib/cjs/redis/RedisContextLock.cjs

@@ -0,0 +1,185 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisContextLock = void 0;
+const core_1 = require("@decaf-ts/core");
+const db_decorators_1 = require("@decaf-ts/db-decorators");
+const redis_1 = require("redis");
+/**
+ * @description Redis-native transaction lock for the Redis adapter
+ * @summary Backs `@transactional()` with a dedicated Redis connection carrying a
+ * native `MULTI` command queue plus an in-memory read cache. Every CRUD write
+ * performed under an active transaction is queued on the native `MULTI` object and
+ * mirrored into the read cache, so the transaction observes its own writes
+ * (read-your-writes) while remaining invisible to every other connection until
+ * {@link RedisContextLock.commit} issues `WATCH` and `EXEC`. If a watched table
+ * changed concurrently, `EXEC` aborts and the transaction raises a
+ * `ConflictError` instead of silently overwriting the concurrent write.
+ *
+ * A dedicated connection is required: `WATCH` is per-connection state on the
+ * node-redis client, so a `WATCH` issued on the shared, multiplexed adapter
+ * client would be cleared or replaced by any concurrent adapter operation (and a
+ * concurrent write to a watched key would abort an unrelated transaction).
+ * @class RedisContextLock
+ * @category Redis
+ */
+class RedisContextLock extends core_1.ContextLock {
+    constructor() {
+        super(...arguments);
+        this.readCache = new Map();
+    }
+    /**
+     * @description Whether a Redis transaction is currently open
+     * @return {boolean} True while a transaction is active
+     */
+    get active() {
+        return !!this.txClient;
+    }
+    /**
+     * @description Returns the buffered entry for a record, when present
+     * @param {string} table - The table (model) name
+     * @param {string} id - The record id
+     * @return {{found: boolean, value?: RedisBufferedValue}} The buffered entry state
+     */
+    getRecord(table, id) {
+        const entries = this.readCache.get(table);
+        if (!entries || !entries.has(id))
+            return { found: false };
+        return { found: true, value: entries.get(id) };
+    }
+    /**
+     * @description Queues a serialized record on the native transaction and buffers it for reads
+     * @param {string} table - The table (model) name
+     * @param {string} id - The record id
+     * @param {string} value - The serialized record
+     * @return {void}
+     */
+    setRecord(table, id, value) {
+        let entries = this.readCache.get(table);
+        if (!entries) {
+            entries = new Map();
+            this.readCache.set(table, entries);
+        }
+        entries.set(id, value);
+        if (!this.multi)
+            return;
+        const key = this.adapter.recordKey(table);
+        if (value === null)
+            this.multi.hDel(key, id);
+        else
+            this.multi.hSet(key, id, value);
+    }
+    /**
+     * @description Queues a record deletion on the native transaction and buffers it
+     * @param {string} table - The table (model) name
+     * @param {string} id - The record id
+     * @return {void}
+     */
+    deleteRecord(table, id) {
+        this.setRecord(table, id, null);
+    }
+    /**
+     * @description Returns the buffered writes for a table, when any exist
+     * @param {string} table - The table (model) name
+     * @return {Map<string, RedisBufferedValue> | undefined} The buffered entries
+     */
+    tableEntries(table) {
+        return this.readCache.get(table);
+    }
+    /**
+     * @description Starts the transaction, opening a dedicated connection and native queue
+     * @summary Delegates to the base implementation so `maxConcurrentTransactions`
+     * continues to gate concurrency, then opens a dedicated connection and its native
+     * `MULTI` command queue.
+     * @param {Context<any>} context - The context the transaction is starting under
+     * @return {Promise<void>} A promise that resolves once the transaction is open
+     */
+    async begin(context) {
+        await super.begin(context);
+        try {
+            const client = this.adapter.client.duplicate();
+            await client.connect();
+            this.txClient = client;
+            this.multi = this.txClient.multi();
+        }
+        catch (e) {
+            await super.rollback(e, context);
+            throw e;
+        }
+    }
+    /**
+     * @description Flushes the queued writes atomically and ends the transaction
+     * @summary `WATCH`es every touched table on the dedicated connection, then runs
+     * the native `MULTI` queue with `EXEC`. If a watched table changed concurrently,
+     * `EXEC` aborts with a `WatchError` and the transaction raises a
+     * `ConflictError`. On success (or conflict) the dedicated connection is released
+     * and the concurrency permit returned.
+     * @param {Context<any>} context - The context the transaction ran under
+     * @return {Promise<void>} A promise that resolves once the transaction ends
+     */
+    async commit(context) {
+        if (!this.txClient || !this.multi) {
+            await super.commit(context);
+            return;
+        }
+        const watched = [...this.readCache.keys()].map((table) => this.adapter.recordKey(table));
+        try {
+            if (watched.length)
+                await this.txClient.watch(watched);
+            await this.multi.exec();
+        }
+        catch (e) {
+            if (e instanceof redis_1.WatchError)
+                throw new db_decorators_1.ConflictError("Redis transaction aborted: a watched record changed concurrently");
+            throw e;
+        }
+        finally {
+            await this.releaseTx();
+            await super.commit(context);
+        }
+    }
+    /**
+     * @description Discards the queued writes and ends the transaction
+     * @param {Error} err - The error that triggered the rollback
+     * @param {Context<any>} context - The context the transaction ran under
+     * @return {Promise<void>} A promise that resolves once the transaction ends
+     */
+    async rollback(err, context) {
+        await this.releaseTx();
+        await super.rollback(err, context);
+    }
+    /**
+     * @description Releases the dedicated transaction connection and clears state
+     * @summary Unwatches and closes the dedicated connection, then clears the native
+     * queue and read cache so queued writes are never applied after rollback or after
+     * an already flushed commit.
+     * @return {Promise<void>} A promise that resolves once the connection is released
+     */
+    async releaseTx() {
+        const client = this.txClient;
+        this.txClient = undefined;
+        this.multi = undefined;
+        this.readCache.clear();
+        if (!client)
+            return;
+        try {
+            await client.unwatch();
+        }
+        catch {
+            // the connection may already be gone; nothing left to unwatch
+        }
+        try {
+            await client.quit();
+        }
+        catch {
+            try {
+                client.destroy();
+            }
+            catch {
+                // connection already closed
+            }
+        }
+    }
+}
+exports.RedisContextLock = RedisContextLock;
+//# sourceMappingURL=RedisContextLock.js.map
+//# sourceMappingURL=RedisContextLock.cjs.map

package/lib/cjs/redis/RedisContextLock.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis/RedisContextLock.cjs","sourceRoot":"","sources":["redis/RedisContextLock.js"],"names":[],"mappings":";;;AAAA,yCAA6C;AAC7C,2DAAwD;AACxD,iCAAmC;AACnC;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,gBAAiB,SAAQ,kBAAW;IAC7C;QACI,KAAK,CAAC,GAAG,SAAS,CAAC,CAAC;QACpB,IAAI,CAAC,SAAS,GAAG,IAAI,GAAG,EAAE,CAAC;IAC/B,CAAC;IACD;;;OAGG;IACH,IAAI,MAAM;QACN,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IAC3B,CAAC;IACD;;;;;OAKG;IACH,SAAS,CAAC,KAAK,EAAE,EAAE;QACf,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;QAC5B,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;IACnD,CAAC;IACD;;;;;;OAMG;IACH,SAAS,CAAC,KAAK,EAAE,EAAE,EAAE,KAAK;QACtB,IAAI,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACxC,IAAI,CAAC,OAAO,EAAE,CAAC;YACX,OAAO,GAAG,IAAI,GAAG,EAAE,CAAC;YACpB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QACvB,IAAI,CAAC,IAAI,CAAC,KAAK;YACX,OAAO;QACX,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,KAAK,KAAK,IAAI;YACd,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;;YAEzB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;IACxC,CAAC;IACD;;;;;OAKG;IACH,YAAY,CAAC,KAAK,EAAE,EAAE;QAClB,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;IACpC,CAAC;IACD;;;;OAIG;IACH,YAAY,CAAC,KAAK;QACd,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IACD;;;;;;;OAOG;IACH,KAAK,CAAC,KAAK,CAAC,OAAO;QACf,MAAM,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC3B,IAAI,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YAC/C,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;YACvB,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC;YACvB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACvC,CAAC;QACD,OAAO,CAAC,EAAE,CAAC;YACP,MAAM,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YACjC,MAAM,CAAC,CAAC;QACZ,CAAC;IACL,CAAC;IACD;;;;;;;;;OASG;IACH,KAAK,CAAC,MAAM,CAAC,OAAO;QAChB,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAChC,MAAM,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC5B,OAAO;QACX,CAAC;QACD,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;QACzF,IAAI,CAAC;YACD,IAAI,OAAO,CAAC,MAAM;gBACd,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACvC,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QAC5B,CAAC;QACD,OAAO,CAAC,EAAE,CAAC;YACP,IAAI,CAAC,YAAY,kBAAU;gBACvB,MAAM,IAAI,6BAAa,CAAC,kEAAkE,CAAC,CAAC;YAChG,MAAM,CAAC,CAAC;QACZ,CAAC;gBACO,CAAC;YACL,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;YACvB,MAAM,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAChC,CAAC;IACL,CAAC;IACD;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO;QACvB,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACvB,MAAM,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC;IACD;;;;;;OAMG;IACH,KAAK,CAAC,SAAS;QACX,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1B,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;QACvB,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QACvB,IAAI,CAAC,MAAM;YACP,OAAO;QACX,IAAI,CAAC;YACD,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;QAC3B,CAAC;QACD,MAAM,CAAC;YACH,8DAA8D;QAClE,CAAC;QACD,IAAI,CAAC;YACD,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;QACxB,CAAC;QACD,MAAM,CAAC;YACH,IAAI,CAAC;gBACD,MAAM,CAAC,OAAO,EAAE,CAAC;YACrB,CAAC;YACD,MAAM,CAAC;gBACH,4BAA4B;YAChC,CAAC;QACL,CAAC;IACL,CAAC;CACJ;AA7JD,4CA6JC;AACD,4CAA4C"}

package/lib/cjs/redis/RedisDispatch.cjs

@@ -0,0 +1,132 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisDispatch = void 0;
+const core_1 = require("@decaf-ts/core");
+const db_decorators_1 = require("@decaf-ts/db-decorators");
+const decorator_validation_1 = require("@decaf-ts/decorator-validation");
+const crypto_1 = require("crypto");
+const constants_js_1 = require("./constants.cjs");
+/**
+ * @description Dispatcher for Redis change events
+ * @summary Extends the core `Dispatch` to broadcast record changes over Redis
+ * pub/sub so that every process sharing the same database refreshes its observers.
+ * Local observer updates are still performed synchronously through the base class;
+ * the published message carries an `origin` id so a process ignores the echo of its
+ * own events and never notifies its observers twice.
+ * @class RedisDispatch
+ * @category Redis
+ */
+class RedisDispatch extends core_1.Dispatch {
+    constructor() {
+        super(...arguments);
+        this.origin = (0, crypto_1.randomUUID)();
+        /**
+         * @description Whether the pub/sub subscription is currently active
+         */
+        this.active = false;
+    }
+    /**
+     * @description Initializes the dispatcher and opens the pub/sub subscription
+     * @summary Proxies the adapter's CRUD methods through the base implementation,
+     * then opens a dedicated subscriber connection listening for change events.
+     * @param {...ContextualArgs} args - Contextual arguments
+     * @return {Promise<void>} A promise that resolves once initialization is complete
+     */
+    async initialize(...args) {
+        await super.initialize(...args);
+        if (!this.adapter)
+            return;
+        try {
+            const subscriber = this.adapter.client.duplicate();
+            await subscriber.connect();
+            await subscriber.subscribe(constants_js_1.RedisEventsChannel, (message) => void this.changeHandler(message));
+            this.subscriber = subscriber;
+            this.active = true;
+        }
+        catch (e) {
+            this.log
+                .for(this.initialize)
+                .error(`Failed to subscribe to Redis change events: ${e}`);
+        }
+    }
+    /**
+     * @description Closes the dispatcher and releases the pub/sub subscription
+     * @param {...ContextualArgs} args - Contextual arguments
+     * @return {Promise<void>} A promise that resolves once the dispatcher is closed
+     */
+    async close(...args) {
+        this.active = false;
+        const subscriber = this.subscriber;
+        this.subscriber = undefined;
+        if (subscriber) {
+            try {
+                await subscriber.unsubscribe(constants_js_1.RedisEventsChannel);
+            }
+            catch (e) {
+                this.log
+                    .for(this.close)
+                    .error(`Failed to unsubscribe from Redis change events: ${e}`);
+            }
+            try {
+                await subscriber.quit();
+            }
+            catch (e) {
+                this.log
+                    .for(this.close)
+                    .error(`Failed to close Redis change subscriber: ${e}`);
+            }
+        }
+        return super.close(...args);
+    }
+    /**
+     * @description Notifies local observers and broadcasts the event to other processes
+     * @summary Performs the base local refresh, then publishes the change to the
+     * Redis pub/sub channel. Remote processes receive the event and refresh their own
+     * observers; the originating process ignores its own message.
+     * @param {Constructor<any> | string} model - The model (or table name) that changed
+     * @param {OperationKeys | BulkCrudOperationKeys | string} event - The operation that occurred
+     * @param {any} id - The identifier(s) of the affected record(s)
+     * @param {...ContextualArgs} args - Contextual arguments
+     * @return {Promise<void>} A promise that resolves once observers are notified
+     */
+    async updateObservers(model, event, id, ...args) {
+        await super.updateObservers(model, event, id, ...args);
+        if (!this.adapter)
+            return;
+        const table = model && typeof model === "string" ? model : decorator_validation_1.Model.tableName(model);
+        try {
+            await this.adapter.client.publish(constants_js_1.RedisEventsChannel, JSON.stringify({ origin: this.origin, table, event: String(event), id }));
+        }
+        catch (e) {
+            this.log
+                .for(this.updateObservers)
+                .error(`Failed to publish Redis change event: ${e}`);
+        }
+    }
+    /**
+     * @description Handles an incoming Redis change event
+     * @summary Ignores the echo of locally published events and refreshes the
+     * observers of this process for events published elsewhere.
+     * @param {string} message - The raw JSON pub/sub payload
+     * @return {Promise<void>} A promise that resolves once observers are notified
+     */
+    async changeHandler(message) {
+        try {
+            const parsed = JSON.parse(message);
+            if (parsed.origin === this.origin)
+                return;
+            if (!this.adapter)
+                return;
+            const ctx = await this.adapter.context(db_decorators_1.OperationKeys.UPDATE, {}, decorator_validation_1.Model);
+            await super.updateObservers(parsed.table, parsed.event, parsed.id, ctx);
+        }
+        catch (e) {
+            this.log
+                .for(this.changeHandler)
+                .error(`Failed to process Redis change event: ${e}`);
+        }
+    }
+}
+exports.RedisDispatch = RedisDispatch;
+//# sourceMappingURL=RedisDispatch.js.map
+//# sourceMappingURL=RedisDispatch.cjs.map

package/lib/cjs/redis/RedisDispatch.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis/RedisDispatch.cjs","sourceRoot":"","sources":["redis/RedisDispatch.js"],"names":[],"mappings":";;;AAAA,yCAA0C;AAC1C,2DAAwD;AACxD,yEAAuD;AACvD,mCAAoC;AACpC,iDAAoD;AACpD;;;;;;;;;GASG;AACH,MAAa,aAAc,SAAQ,eAAQ;IACvC;QACI,KAAK,CAAC,GAAG,SAAS,CAAC,CAAC;QACpB,IAAI,CAAC,MAAM,GAAG,IAAA,mBAAU,GAAE,CAAC;QAC3B;;WAEG;QACH,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACxB,CAAC;IACD;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CAAC,GAAG,IAAI;QACpB,MAAM,KAAK,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,CAAC,OAAO;YACb,OAAO;QACX,IAAI,CAAC;YACD,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YACnD,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC;YAC3B,MAAM,UAAU,CAAC,SAAS,CAAC,iCAAkB,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;YAC9F,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;YAC7B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACvB,CAAC;QACD,OAAO,CAAC,EAAE,CAAC;YACP,IAAI,CAAC,GAAG;iBACH,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC;iBACpB,KAAK,CAAC,+CAA+C,CAAC,EAAE,CAAC,CAAC;QACnE,CAAC;IACL,CAAC;IACD;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,GAAG,IAAI;QACf,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACnC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,UAAU,EAAE,CAAC;YACb,IAAI,CAAC;gBACD,MAAM,UAAU,CAAC,WAAW,CAAC,iCAAkB,CAAC,CAAC;YACrD,CAAC;YACD,OAAO,CAAC,EAAE,CAAC;gBACP,IAAI,CAAC,GAAG;qBACH,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC;qBACf,KAAK,CAAC,mDAAmD,CAAC,EAAE,CAAC,CAAC;YACvE,CAAC;YACD,IAAI,CAAC;gBACD,MAAM,UAAU,CAAC,IAAI,EAAE,CAAC;YAC5B,CAAC;YACD,OAAO,CAAC,EAAE,CAAC;gBACP,IAAI,CAAC,GAAG;qBACH,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC;qBACf,KAAK,CAAC,4CAA4C,CAAC,EAAE,CAAC,CAAC;YAChE,CAAC;QACL,CAAC;QACD,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;IAChC,CAAC;IACD;;;;;;;;;;OAUG;IACH,KAAK,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,IAAI;QAC3C,MAAM,KAAK,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;QACvD,IAAI,CAAC,IAAI,CAAC,OAAO;YACb,OAAO;QACX,MAAM,KAAK,GAAG,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,4BAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAClF,IAAI,CAAC;YACD,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,iCAAkB,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;QACpI,CAAC;QACD,OAAO,CAAC,EAAE,CAAC;YACP,IAAI,CAAC,GAAG;iBACH,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC;iBACzB,KAAK,CAAC,yCAAyC,CAAC,EAAE,CAAC,CAAC;QAC7D,CAAC;IACL,CAAC;IACD;;;;;;OAMG;IACH,KAAK,CAAC,aAAa,CAAC,OAAO;QACvB,IAAI,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACnC,IAAI,MAAM,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM;gBAC7B,OAAO;YACX,IAAI,CAAC,IAAI,CAAC,OAAO;gBACb,OAAO;YACX,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,6BAAa,CAAC,MAAM,EAAE,EAAE,EAAE,4BAAK,CAAC,CAAC;YACxE,MAAM,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;QAC5E,CAAC;QACD,OAAO,CAAC,EAAE,CAAC;YACP,IAAI,CAAC,GAAG;iBACH,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC;iBACvB,KAAK,CAAC,yCAAyC,CAAC,EAAE,CAAC,CAAC;QAC7D,CAAC;IACL,CAAC;CACJ;AA9GD,sCA8GC;AACD,yCAAyC"}

package/lib/cjs/redis/RedisPaginator.cjs

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisPaginator = void 0;
+const core_1 = require("@decaf-ts/core");
+const decorator_validation_1 = require("@decaf-ts/decorator-validation");
+/**
+ * @description Redis-specific paginator implementation
+ * @summary Extends the base Paginator class to provide pagination functionality for
+ * Redis adapter queries. This class handles the pagination of query results loaded
+ * from Redis, allowing for efficient retrieval of large result sets in smaller chunks.
+ * @template M - The model type being paginated
+ * @class RedisPaginator
+ * @category Redis
+ * @example
+ * ```typescript
+ * // Create a query for User model
+ * const query: RawRedisQuery<User> = {
+ *   select: undefined, // Select all fields
+ *   from: User,
+ *   where: (user) => user.active === true
+ * };
+ *
+ * // Create a paginator with page size of 10
+ * const paginator = new RedisPaginator<User>(adapter, query, 10, User);
+ *
+ * // Get the first page of results
+ * const firstPage = await paginator.page(1);
+ *
+ * // Get the next page
+ * const secondPage = await paginator.page(2);
+ * ```
+ */
+class RedisPaginator extends core_1.Paginator {
+    /**
+     * @description Creates a paginator bound to the Redis adapter
+     * @param {Adapter<any, any, RawRedisQuery<M>, any>} adapter - The Redis adapter instance
+     * @param {RawRedisQuery<M>} query - The raw query to paginate
+     * @param {number} size - The number of records per page
+     * @param {Constructor<M>} clazz - The model constructor being paginated
+     */
+    constructor(adapter, query, size, clazz) {
+        super(adapter, query, size, clazz);
+    }
+    /**
+     * @description Prepares a Redis query for pagination
+     * @summary Modifies the raw query statement to include pagination parameters.
+     * This protected method sets the limit parameter on the query to match the page size.
+     * @param {RawRedisQuery<M>} rawStatement - The original query statement
+     * @return {RawRedisQuery<M>} The modified query with pagination parameters
+     */
+    prepare(rawStatement) {
+        const query = Object.assign({}, rawStatement);
+        query.limit = this.size;
+        return query;
+    }
+    /**
+     * @description Retrieves a specific page of results
+     * @summary Executes the query with pagination parameters to retrieve a specific page of results.
+     * This method calculates the appropriate skip value based on the page number and page size,
+     * executes the query, and updates the current page tracking.
+     * @param {number} [page=1] - The page number to retrieve (1-based)
+     * @return {Promise<R[]>} A promise that resolves to an array of results for the requested page
+     */
+    async page(page = 1, ...args) {
+        const { ctx, ctxArgs } = this.adapter["logCtx"](args, this.page);
+        if (this.isPreparedStatement()) {
+            return this.pagePrepared(page, ...ctxArgs);
+        }
+        const statement = this.prepare(this.statement);
+        let results;
+        if (!this._recordCount || !this._totalPages) {
+            this._totalPages = this._recordCount = 0;
+            results = await this.adapter.raw({ ...statement, limit: Number.MAX_SAFE_INTEGER }, false, ctx);
+            this._recordCount = results.count || results.data.length;
+            if (this._recordCount > 0) {
+                const size = statement?.limit || this.size;
+                this._totalPages = Math.ceil(this._recordCount / size);
+                return await this.page(page, ...ctxArgs);
+            }
+        }
+        else {
+            page = this.validatePage(page);
+            statement.skip = (page - 1) * this.size;
+            results = await this.adapter.raw(statement, true, ...ctxArgs);
+        }
+        this._currentPage = page;
+        this._bookmark = results.length
+            ? results[results.length - 1][decorator_validation_1.Model.pk(this.clazz)]
+            : undefined;
+        return results.data || results;
+    }
+}
+exports.RedisPaginator = RedisPaginator;
+//# sourceMappingURL=RedisPaginator.js.map
+//# sourceMappingURL=RedisPaginator.cjs.map

package/lib/cjs/redis/RedisPaginator.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis/RedisPaginator.cjs","sourceRoot":"","sources":["redis/RedisPaginator.js"],"names":[],"mappings":";;;AAAA,yCAA4C;AAC5C,yEAAuD;AACvD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAa,cAAe,SAAQ,gBAAS;IACzC;;;;;;OAMG;IACH,YAAY,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK;QACnC,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IACvC,CAAC;IACD;;;;;;OAMG;IACH,OAAO,CAAC,YAAY;QAChB,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;QAC9C,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC;QACxB,OAAO,KAAK,CAAC;IACjB,CAAC;IACD;;;;;;;OAOG;IACH,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,EAAE,GAAG,IAAI;QACxB,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACjE,IAAI,IAAI,CAAC,mBAAmB,EAAE,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,GAAG,OAAO,CAAC,CAAC;QAC/C,CAAC;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/C,IAAI,OAAO,CAAC;QACZ,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YAC1C,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;YACzC,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,GAAG,SAAS,EAAE,KAAK,EAAE,MAAM,CAAC,gBAAgB,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;YAC/F,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;YACzD,IAAI,IAAI,CAAC,YAAY,GAAG,CAAC,EAAE,CAAC;gBACxB,MAAM,IAAI,GAAG,SAAS,EAAE,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC;gBAC3C,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;gBACvD,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,OAAO,CAAC,CAAC;YAC7C,CAAC;QACL,CAAC;aACI,CAAC;YACF,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;YAC/B,SAAS,CAAC,IAAI,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC;YACxC,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,CAAC;QAClE,CAAC;QACD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM;YAC3B,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,4BAAK,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACnD,CAAC,CAAC,SAAS,CAAC;QAChB,OAAO,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC;IACnC,CAAC;CACJ;AA3DD,wCA2DC;AACD,0CAA0C"}