@push.rocks/smartmongo 3.0.0 → 4.0.0

package/dist_ts/tsmdb/engine/QueryPlanner.d.ts

@@ -0,0 +1,64 @@
+import type { Document } from '../types/interfaces.js';
+import { IndexEngine } from './IndexEngine.js';
+/**
+ * Query execution plan types
+ */
+export type TQueryPlanType = 'IXSCAN' | 'COLLSCAN' | 'FETCH' | 'IXSCAN_RANGE';
+/**
+ * Represents a query execution plan
+ */
+export interface IQueryPlan {
+    /** The type of scan used */
+    type: TQueryPlanType;
+    /** Index name if using an index */
+    indexName?: string;
+    /** Index key specification */
+    indexKey?: Record<string, 1 | -1 | string>;
+    /** Whether the query can be fully satisfied by the index */
+    indexCovering: boolean;
+    /** Estimated selectivity (0-1, lower is more selective) */
+    selectivity: number;
+    /** Whether range operators are used */
+    usesRange: boolean;
+    /** Fields used from the index */
+    indexFieldsUsed: string[];
+    /** Filter conditions that must be applied post-index lookup */
+    residualFilter?: Document;
+    /** Explanation for debugging */
+    explanation: string;
+}
+/**
+ * QueryPlanner - Analyzes queries and selects optimal execution plans
+ */
+export declare class QueryPlanner {
+    private indexEngine;
+    constructor(indexEngine: IndexEngine);
+    /**
+     * Generate an execution plan for a query filter
+     */
+    plan(filter: Document): Promise<IQueryPlan>;
+    /**
+     * Analyze filter to extract operator information per field
+     */
+    private analyzeFilter;
+    /**
+     * Score an index for the given filter
+     */
+    private scoreIndex;
+    /**
+     * Calculate overall score for a plan (higher is better)
+     */
+    private calculateScore;
+    /**
+     * Explain a query - returns detailed plan information
+     */
+    explain(filter: Document): Promise<{
+        queryPlanner: {
+            plannerVersion: number;
+            namespace: string;
+            indexFilterSet: boolean;
+            winningPlan: IQueryPlan;
+            rejectedPlans: IQueryPlan[];
+        };
+    }>;
+}

package/dist_ts/tsmdb/engine/QueryPlanner.js

@@ -0,0 +1,308 @@
+import * as plugins from '../tsmdb.plugins.js';
+import { IndexEngine } from './IndexEngine.js';
+/**
+ * QueryPlanner - Analyzes queries and selects optimal execution plans
+ */
+export class QueryPlanner {
+    indexEngine;
+    constructor(indexEngine) {
+        this.indexEngine = indexEngine;
+    }
+    /**
+     * Generate an execution plan for a query filter
+     */
+    async plan(filter) {
+        await this.indexEngine['initialize']();
+        // Empty filter = full collection scan
+        if (!filter || Object.keys(filter).length === 0) {
+            return {
+                type: 'COLLSCAN',
+                indexCovering: false,
+                selectivity: 1.0,
+                usesRange: false,
+                indexFieldsUsed: [],
+                explanation: 'No filter specified, full collection scan required',
+            };
+        }
+        // Analyze the filter
+        const operatorInfo = this.analyzeFilter(filter);
+        // Get available indexes
+        const indexes = await this.indexEngine.listIndexes();
+        // Score each index
+        let bestPlan = null;
+        let bestScore = -1;
+        for (const index of indexes) {
+            const plan = this.scoreIndex(index, operatorInfo, filter);
+            if (plan.selectivity < 1.0) {
+                const score = this.calculateScore(plan);
+                if (score > bestScore) {
+                    bestScore = score;
+                    bestPlan = plan;
+                }
+            }
+        }
+        // If no suitable index found, fall back to collection scan
+        if (!bestPlan || bestScore <= 0) {
+            return {
+                type: 'COLLSCAN',
+                indexCovering: false,
+                selectivity: 1.0,
+                usesRange: false,
+                indexFieldsUsed: [],
+                explanation: 'No suitable index found for this query',
+            };
+        }
+        return bestPlan;
+    }
+    /**
+     * Analyze filter to extract operator information per field
+     */
+    analyzeFilter(filter, prefix = '') {
+        const result = new Map();
+        for (const [key, value] of Object.entries(filter)) {
+            // Skip logical operators at the top level
+            if (key.startsWith('$')) {
+                if (key === '$and' && Array.isArray(value)) {
+                    // Merge $and conditions
+                    for (const subFilter of value) {
+                        const subInfo = this.analyzeFilter(subFilter, prefix);
+                        for (const [field, info] of subInfo) {
+                            if (result.has(field)) {
+                                // Merge operators
+                                const existing = result.get(field);
+                                existing.operators.push(...info.operators);
+                                existing.equality = existing.equality || info.equality;
+                                existing.range = existing.range || info.range;
+                                existing.in = existing.in || info.in;
+                                Object.assign(existing.values, info.values);
+                            }
+                            else {
+                                result.set(field, info);
+                            }
+                        }
+                    }
+                }
+                continue;
+            }
+            const fullKey = prefix ? `${prefix}.${key}` : key;
+            const info = {
+                field: fullKey,
+                operators: [],
+                equality: false,
+                range: false,
+                in: false,
+                exists: false,
+                regex: false,
+                values: {},
+            };
+            if (typeof value !== 'object' || value === null || value instanceof plugins.bson.ObjectId || value instanceof Date) {
+                // Direct equality
+                info.equality = true;
+                info.operators.push('$eq');
+                info.values['$eq'] = value;
+            }
+            else if (Array.isArray(value)) {
+                // Array equality (rare, but possible)
+                info.equality = true;
+                info.operators.push('$eq');
+                info.values['$eq'] = value;
+            }
+            else {
+                // Operator object
+                for (const [op, opValue] of Object.entries(value)) {
+                    if (op.startsWith('$')) {
+                        info.operators.push(op);
+                        info.values[op] = opValue;
+                        switch (op) {
+                            case '$eq':
+                                info.equality = true;
+                                break;
+                            case '$ne':
+                            case '$not':
+                                // These can use indexes but with low selectivity
+                                break;
+                            case '$in':
+                                info.in = true;
+                                break;
+                            case '$nin':
+                                // Can't efficiently use indexes
+                                break;
+                            case '$gt':
+                            case '$gte':
+                            case '$lt':
+                            case '$lte':
+                                info.range = true;
+                                break;
+                            case '$exists':
+                                info.exists = true;
+                                break;
+                            case '$regex':
+                                info.regex = true;
+                                break;
+                        }
+                    }
+                    else {
+                        // Nested object - recurse
+                        const nestedInfo = this.analyzeFilter({ [op]: opValue }, fullKey);
+                        for (const [nestedField, nestedFieldInfo] of nestedInfo) {
+                            result.set(nestedField, nestedFieldInfo);
+                        }
+                    }
+                }
+            }
+            if (info.operators.length > 0) {
+                result.set(fullKey, info);
+            }
+        }
+        return result;
+    }
+    /**
+     * Score an index for the given filter
+     */
+    scoreIndex(index, operatorInfo, filter) {
+        const indexFields = Object.keys(index.key);
+        const usedFields = [];
+        let usesRange = false;
+        let canUseIndex = true;
+        let selectivity = 1.0;
+        let residualFilter;
+        // Check each index field in order
+        for (const field of indexFields) {
+            const info = operatorInfo.get(field);
+            if (!info) {
+                // Index field not in filter - stop here
+                break;
+            }
+            usedFields.push(field);
+            // Calculate selectivity based on operator
+            if (info.equality) {
+                // Equality has high selectivity
+                selectivity *= 0.01; // Assume 1% match
+            }
+            else if (info.in) {
+                // $in selectivity depends on array size
+                const inValues = info.values['$in'];
+                if (Array.isArray(inValues)) {
+                    selectivity *= Math.min(0.5, inValues.length * 0.01);
+                }
+                else {
+                    selectivity *= 0.1;
+                }
+            }
+            else if (info.range) {
+                // Range queries have moderate selectivity
+                selectivity *= 0.25;
+                usesRange = true;
+                // After range, can't use more index fields efficiently
+                break;
+            }
+            else if (info.exists) {
+                // $exists can use sparse indexes
+                selectivity *= 0.5;
+            }
+            else {
+                // Other operators may not be indexable
+                canUseIndex = false;
+                break;
+            }
+        }
+        if (!canUseIndex || usedFields.length === 0) {
+            return {
+                type: 'COLLSCAN',
+                indexCovering: false,
+                selectivity: 1.0,
+                usesRange: false,
+                indexFieldsUsed: [],
+                explanation: `Index ${index.name} cannot be used for this query`,
+            };
+        }
+        // Build residual filter for conditions not covered by index
+        const coveredFields = new Set(usedFields);
+        const residualConditions = {};
+        for (const [field, info] of operatorInfo) {
+            if (!coveredFields.has(field)) {
+                // This field isn't covered by the index
+                if (info.equality) {
+                    residualConditions[field] = info.values['$eq'];
+                }
+                else {
+                    residualConditions[field] = info.values;
+                }
+            }
+        }
+        if (Object.keys(residualConditions).length > 0) {
+            residualFilter = residualConditions;
+        }
+        // Unique indexes have better selectivity for equality
+        if (index.unique && usedFields.length === indexFields.length) {
+            selectivity = Math.min(selectivity, 0.001); // At most 1 document
+        }
+        return {
+            type: usesRange ? 'IXSCAN_RANGE' : 'IXSCAN',
+            indexName: index.name,
+            indexKey: index.key,
+            indexCovering: Object.keys(residualConditions).length === 0,
+            selectivity,
+            usesRange,
+            indexFieldsUsed: usedFields,
+            residualFilter,
+            explanation: `Using index ${index.name} on fields [${usedFields.join(', ')}]`,
+        };
+    }
+    /**
+     * Calculate overall score for a plan (higher is better)
+     */
+    calculateScore(plan) {
+        let score = 0;
+        // Lower selectivity is better (fewer documents to fetch)
+        score += (1 - plan.selectivity) * 100;
+        // Index covering queries are best
+        if (plan.indexCovering) {
+            score += 50;
+        }
+        // More index fields used is better
+        score += plan.indexFieldsUsed.length * 10;
+        // Equality scans are better than range scans
+        if (!plan.usesRange) {
+            score += 20;
+        }
+        return score;
+    }
+    /**
+     * Explain a query - returns detailed plan information
+     */
+    async explain(filter) {
+        await this.indexEngine['initialize']();
+        // Analyze the filter
+        const operatorInfo = this.analyzeFilter(filter);
+        // Get available indexes
+        const indexes = await this.indexEngine.listIndexes();
+        // Score all indexes
+        const plans = [];
+        for (const index of indexes) {
+            const plan = this.scoreIndex(index, operatorInfo, filter);
+            plans.push(plan);
+        }
+        // Add collection scan as fallback
+        plans.push({
+            type: 'COLLSCAN',
+            indexCovering: false,
+            selectivity: 1.0,
+            usesRange: false,
+            indexFieldsUsed: [],
+            explanation: 'Full collection scan',
+        });
+        // Sort by score (best first)
+        plans.sort((a, b) => this.calculateScore(b) - this.calculateScore(a));
+        return {
+            queryPlanner: {
+                plannerVersion: 1,
+                namespace: `${this.indexEngine['dbName']}.${this.indexEngine['collName']}`,
+                indexFilterSet: false,
+                winningPlan: plans[0],
+                rejectedPlans: plans.slice(1),
+            },
+        };
+    }
+}
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"QueryPlanner.js","sourceRoot":"","sources":["../../../ts/tsmdb/engine/QueryPlanner.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,qBAAqB,CAAC;AAE/C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AA6C/C;;GAEG;AACH,MAAM,OAAO,YAAY;IACf,WAAW,CAAc;IAEjC,YAAY,WAAwB;QAClC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,MAAgB;QACzB,MAAM,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,EAAE,CAAC;QAEvC,sCAAsC;QACtC,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChD,OAAO;gBACL,IAAI,EAAE,UAAU;gBAChB,aAAa,EAAE,KAAK;gBACpB,WAAW,EAAE,GAAG;gBAChB,SAAS,EAAE,KAAK;gBAChB,eAAe,EAAE,EAAE;gBACnB,WAAW,EAAE,oDAAoD;aAClE,CAAC;QACJ,CAAC;QAED,qBAAqB;QACrB,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAEhD,wBAAwB;QACxB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC;QAErD,mBAAmB;QACnB,IAAI,QAAQ,GAAsB,IAAI,CAAC;QACvC,IAAI,SAAS,GAAG,CAAC,CAAC,CAAC;QAEnB,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;YAC1D,IAAI,IAAI,CAAC,WAAW,GAAG,GAAG,EAAE,CAAC;gBAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;gBACxC,IAAI,KAAK,GAAG,SAAS,EAAE,CAAC;oBACtB,SAAS,GAAG,KAAK,CAAC;oBAClB,QAAQ,GAAG,IAAI,CAAC;gBAClB,CAAC;YACH,CAAC;QACH,CAAC;QAED,2DAA2D;QAC3D,IAAI,CAAC,QAAQ,IAAI,SAAS,IAAI,CAAC,EAAE,CAAC;YAChC,OAAO;gBACL,IAAI,EAAE,UAAU;gBAChB,aAAa,EAAE,KAAK;gBACpB,WAAW,EAAE,GAAG;gBAChB,SAAS,EAAE,KAAK;gBAChB,eAAe,EAAE,EAAE;gBACnB,WAAW,EAAE,wCAAwC;aACtD,CAAC;QACJ,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;OAEG;IACK,aAAa,CAAC,MAAgB,EAAE,MAAM,GAAG,EAAE;QACjD,MAAM,MAAM,GAAG,IAAI,GAAG,EAA+B,CAAC;QAEtD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAClD,0CAA0C;YAC1C,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBACxB,IAAI,GAAG,KAAK,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC3C,wBAAwB;oBACxB,KAAK,MAAM,SAAS,IAAI,KAAK,EAAE,CAAC;wBAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;wBACtD,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,OAAO,EAAE,CAAC;4BACpC,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;gCACtB,kBAAkB;gCAClB,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAE,CAAC;gCACpC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;gCAC3C,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC;gCACvD,QAAQ,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC;gCAC9C,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,EAAE,IAAI,IAAI,CAAC,EAAE,CAAC;gCACrC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;4BAC9C,CAAC;iCAAM,CAAC;gCACN,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;4BAC1B,CAAC;wBACH,CAAC;oBACH,CAAC;gBACH,CAAC;gBACD,SAAS;YACX,CAAC;YAED,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;YAClD,MAAM,IAAI,GAAwB;gBAChC,KAAK,EAAE,OAAO;gBACd,SAAS,EAAE,EAAE;gBACb,QAAQ,EAAE,KAAK;gBACf,KAAK,EAAE,KAAK;gBACZ,EAAE,EAAE,KAAK;gBACT,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,KAAK;gBACZ,MAAM,EAAE,EAAE;aACX,CAAC;YAEF,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,YAAY,OAAO,CAAC,IAAI,CAAC,QAAQ,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;gBACnH,kBAAkB;gBAClB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;gBACrB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC3B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;YAC7B,CAAC;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChC,sCAAsC;gBACtC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;gBACrB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC3B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACN,kBAAkB;gBAClB,KAAK,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBAClD,IAAI,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;wBACvB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;wBACxB,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC;wBAE1B,QAAQ,EAAE,EAAE,CAAC;4BACX,KAAK,KAAK;gCACR,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;gCACrB,MAAM;4BACR,KAAK,KAAK,CAAC;4BACX,KAAK,MAAM;gCACT,iDAAiD;gCACjD,MAAM;4BACR,KAAK,KAAK;gCACR,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC;gCACf,MAAM;4BACR,KAAK,MAAM;gCACT,gCAAgC;gCAChC,MAAM;4BACR,KAAK,KAAK,CAAC;4BACX,KAAK,MAAM,CAAC;4BACZ,KAAK,KAAK,CAAC;4BACX,KAAK,MAAM;gCACT,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;gCAClB,MAAM;4BACR,KAAK,SAAS;gCACZ,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;gCACnB,MAAM;4BACR,KAAK,QAAQ;gCACX,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;gCAClB,MAAM;wBACV,CAAC;oBACH,CAAC;yBAAM,CAAC;wBACN,0BAA0B;wBAC1B,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;wBAClE,KAAK,MAAM,CAAC,WAAW,EAAE,eAAe,CAAC,IAAI,UAAU,EAAE,CAAC;4BACxD,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;wBAC3C,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YAED,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC9B,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACK,UAAU,CAChB,KAAqF,EACrF,YAA8C,EAC9C,MAAgB;QAEhB,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3C,MAAM,UAAU,GAAa,EAAE,CAAC;QAChC,IAAI,SAAS,GAAG,KAAK,CAAC;QACtB,IAAI,WAAW,GAAG,IAAI,CAAC;QACvB,IAAI,WAAW,GAAG,GAAG,CAAC;QACtB,IAAI,cAAoC,CAAC;QAEzC,kCAAkC;QAClC,KAAK,MAAM,KAAK,IAAI,WAAW,EAAE,CAAC;YAChC,MAAM,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACrC,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,wCAAwC;gBACxC,MAAM;YACR,CAAC;YAED,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAEvB,0CAA0C;YAC1C,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAClB,gCAAgC;gBAChC,WAAW,IAAI,IAAI,CAAC,CAAC,kBAAkB;YACzC,CAAC;iBAAM,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;gBACnB,wCAAwC;gBACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACpC,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC5B,WAAW,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;gBACvD,CAAC;qBAAM,CAAC;oBACN,WAAW,IAAI,GAAG,CAAC;gBACrB,CAAC;YACH,CAAC;iBAAM,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACtB,0CAA0C;gBAC1C,WAAW,IAAI,IAAI,CAAC;gBACpB,SAAS,GAAG,IAAI,CAAC;gBACjB,uDAAuD;gBACvD,MAAM;YACR,CAAC;iBAAM,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBACvB,iCAAiC;gBACjC,WAAW,IAAI,GAAG,CAAC;YACrB,CAAC;iBAAM,CAAC;gBACN,uCAAuC;gBACvC,WAAW,GAAG,KAAK,CAAC;gBACpB,MAAM;YACR,CAAC;QACH,CAAC;QAED,IAAI,CAAC,WAAW,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5C,OAAO;gBACL,IAAI,EAAE,UAAU;gBAChB,aAAa,EAAE,KAAK;gBACpB,WAAW,EAAE,GAAG;gBAChB,SAAS,EAAE,KAAK;gBAChB,eAAe,EAAE,EAAE;gBACnB,WAAW,EAAE,SAAS,KAAK,CAAC,IAAI,gCAAgC;aACjE,CAAC;QACJ,CAAC;QAED,4DAA4D;QAC5D,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC;QAC1C,MAAM,kBAAkB,GAAwB,EAAE,CAAC;QACnD,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,YAAY,EAAE,CAAC;YACzC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC9B,wCAAwC;gBACxC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;oBAClB,kBAAkB,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACjD,CAAC;qBAAM,CAAC;oBACN,kBAAkB,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;gBAC1C,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/C,cAAc,GAAG,kBAAkB,CAAC;QACtC,CAAC;QAED,sDAAsD;QACtD,IAAI,KAAK,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,KAAK,WAAW,CAAC,MAAM,EAAE,CAAC;YAC7D,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC,qBAAqB;QACnE,CAAC;QAED,OAAO;YACL,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ;YAC3C,SAAS,EAAE,KAAK,CAAC,IAAI;YACrB,QAAQ,EAAE,KAAK,CAAC,GAAG;YACnB,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,MAAM,KAAK,CAAC;YAC3D,WAAW;YACX,SAAS;YACT,eAAe,EAAE,UAAU;YAC3B,cAAc;YACd,WAAW,EAAE,eAAe,KAAK,CAAC,IAAI,eAAe,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;SAC9E,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,cAAc,CAAC,IAAgB;QACrC,IAAI,KAAK,GAAG,CAAC,CAAC;QAEd,yDAAyD;QACzD,KAAK,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,GAAG,CAAC;QAEtC,kCAAkC;QAClC,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,KAAK,IAAI,EAAE,CAAC;QACd,CAAC;QAED,mCAAmC;QACnC,KAAK,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,GAAG,EAAE,CAAC;QAE1C,6CAA6C;QAC7C,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,KAAK,IAAI,EAAE,CAAC;QACd,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,MAAgB;QAS5B,MAAM,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,EAAE,CAAC;QAEvC,qBAAqB;QACrB,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAEhD,wBAAwB;QACxB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC;QAErD,oBAAoB;QACpB,MAAM,KAAK,GAAiB,EAAE,CAAC;QAE/B,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;YAC1D,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC;QAED,kCAAkC;QAClC,KAAK,CAAC,IAAI,CAAC;YACT,IAAI,EAAE,UAAU;YAChB,aAAa,EAAE,KAAK;YACpB,WAAW,EAAE,GAAG;YAChB,SAAS,EAAE,KAAK;YAChB,eAAe,EAAE,EAAE;YACnB,WAAW,EAAE,sBAAsB;SACpC,CAAC,CAAC;QAEH,6BAA6B;QAC7B,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;QAEtE,OAAO;YACL,YAAY,EAAE;gBACZ,cAAc,EAAE,CAAC;gBACjB,SAAS,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE;gBAC1E,cAAc,EAAE,KAAK;gBACrB,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC;gBACrB,aAAa,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;aAC9B;SACF,CAAC;IACJ,CAAC;CACF"}

package/dist_ts/tsmdb/engine/SessionEngine.d.ts

@@ -0,0 +1,117 @@
+import type { TransactionEngine } from './TransactionEngine.js';
+/**
+ * Session state
+ */
+export interface ISession {
+    /** Session ID (UUID) */
+    id: string;
+    /** Timestamp when the session was created */
+    createdAt: number;
+    /** Timestamp of the last activity */
+    lastActivityAt: number;
+    /** Current transaction ID if any */
+    txnId?: string;
+    /** Transaction number for ordering */
+    txnNumber?: number;
+    /** Whether the session is in a transaction */
+    inTransaction: boolean;
+    /** Session metadata */
+    metadata?: Record<string, any>;
+}
+/**
+ * Session engine options
+ */
+export interface ISessionEngineOptions {
+    /** Session timeout in milliseconds (default: 30 minutes) */
+    sessionTimeoutMs?: number;
+    /** Interval to check for expired sessions in ms (default: 60 seconds) */
+    cleanupIntervalMs?: number;
+}
+/**
+ * Session engine for managing client sessions
+ * - Tracks session lifecycle (create, touch, end)
+ * - Links sessions to transactions
+ * - Auto-aborts transactions on session expiry
+ */
+export declare class SessionEngine {
+    private sessions;
+    private sessionTimeoutMs;
+    private cleanupInterval?;
+    private transactionEngine?;
+    constructor(options?: ISessionEngineOptions);
+    /**
+     * Set the transaction engine to use for auto-abort
+     */
+    setTransactionEngine(engine: TransactionEngine): void;
+    /**
+     * Start a new session
+     */
+    startSession(sessionId?: string, metadata?: Record<string, any>): ISession;
+    /**
+     * Get a session by ID
+     */
+    getSession(sessionId: string): ISession | undefined;
+    /**
+     * Touch a session to update last activity time
+     */
+    touchSession(sessionId: string): boolean;
+    /**
+     * End a session explicitly
+     * This will also abort any active transaction
+     */
+    endSession(sessionId: string): Promise<boolean>;
+    /**
+     * Start a transaction in a session
+     */
+    startTransaction(sessionId: string, txnId: string, txnNumber?: number): boolean;
+    /**
+     * End a transaction in a session (commit or abort)
+     */
+    endTransaction(sessionId: string): boolean;
+    /**
+     * Get transaction ID for a session
+     */
+    getTransactionId(sessionId: string): string | undefined;
+    /**
+     * Check if session is in a transaction
+     */
+    isInTransaction(sessionId: string): boolean;
+    /**
+     * Check if a session is expired
+     */
+    isSessionExpired(session: ISession): boolean;
+    /**
+     * Cleanup expired sessions
+     * This is called periodically by the cleanup interval
+     */
+    private cleanupExpiredSessions;
+    /**
+     * Get all active sessions
+     */
+    listSessions(): ISession[];
+    /**
+     * Get session count
+     */
+    getSessionCount(): number;
+    /**
+     * Get sessions with active transactions
+     */
+    getSessionsWithTransactions(): ISession[];
+    /**
+     * Refresh session timeout
+     */
+    refreshSession(sessionId: string): boolean;
+    /**
+     * Close the session engine and cleanup
+     */
+    close(): void;
+    /**
+     * Get or create a session for a given session ID
+     * Useful for handling MongoDB driver session requests
+     */
+    getOrCreateSession(sessionId: string): ISession;
+    /**
+     * Extract session ID from MongoDB lsid (logical session ID)
+     */
+    static extractSessionId(lsid: any): string | undefined;
+}