@orion-js/mongodb 4.2.0 → 4.2.3

package/dist/index.d.cts

@@ -304,6 +304,65 @@ declare function createCollection<T extends TypedSchemaOnSchema & {
 }>(options: CreateCollectionOptionsWithTypedSchema<T>): Collection<InferSchemaType<T>>;
 declare function createCollection<T extends ModelClassBase>(options: CreateCollectionOptions<T>): Collection<T>;
 
+/**
+ * Result of the deleteUnusedIndexes operation
+ */
+interface DeleteUnusedIndexesResult {
+    /** Names of the indexes that were deleted */
+    deletedIndexes: string[];
+    /** Name of the collection that was cleaned */
+    collectionName: string;
+}
+
+/**
+ * Registry that tracks all collections created via createCollection().
+ * Maps connection name to a map of collection name to collection instance.
+ * When the same collection is registered multiple times, indexes are merged.
+ */
+declare const collectionsRegistry: Map<string, Map<string, Collection<ModelClassBase>>>;
+/**
+ * Registers a collection in the registry.
+ * Called automatically when a collection is created via createCollection().
+ * If the same collection name is registered multiple times, indexes are merged
+ * to support multiple createCollection() calls for the same collection.
+ * @param connectionName - The name of the MongoDB connection
+ * @param collection - The collection instance to register
+ */
+declare function registerCollection(connectionName: string, collection: Collection<ModelClassBase>): void;
+/**
+ * Gets all registered collections for a specific connection.
+ * @param connectionName - The name of the MongoDB connection (defaults to 'main')
+ * @returns Array of registered collections for the connection
+ */
+declare function getRegisteredCollections(connectionName?: string): Array<Collection<ModelClassBase>>;
+/**
+ * Deletes unused indexes from all registered collections for a connection.
+ * Iterates over all collections registered via createCollection() and
+ * removes indexes that exist in MongoDB but are not defined in the collection configuration.
+ *
+ * **Important**: This function waits for all pending index creation to complete before
+ * deleting any indexes, to avoid race conditions where an index being created might
+ * be incorrectly identified as unused.
+ *
+ * @param connectionName - The name of the MongoDB connection (defaults to 'main')
+ * @returns Array of results for each collection that had indexes deleted
+ *
+ * @example
+ * ```ts
+ * // Delete unused indexes from all collections on the main connection
+ * const results = await deleteAllUnusedIndexes()
+ *
+ * // Delete unused indexes from all collections on a specific connection
+ * const results = await deleteAllUnusedIndexes('secondary')
+ *
+ * // Log results
+ * for (const result of results) {
+ *   console.log(`${result.collectionName}: deleted ${result.deletedIndexes.length} indexes`)
+ * }
+ * ```
+ */
+declare function deleteAllUnusedIndexes(connectionName?: string): Promise<DeleteUnusedIndexesResult[]>;
+
 declare function getOrCreateEncryptionKey({ keyAltName, kmsProvider, masterKey, connectionName, keyVaultDatabase, keyVaultCollection, kmsProviders, }: {
     keyAltName: string;
     kmsProvider: keyof KMSProviders;
@@ -321,4 +380,4 @@ declare const ENCRYPTION_ALGORITHMS: {
     RANDOM: string;
 };
 
-export { BaseCollection, Collection, type CollectionIndex, type CountDocuments, type CreateCollectionOptions, type CreateCollectionOptionsWithSchemaType, type CreateCollectionOptionsWithTypedSchema, DataLoader, type DeleteMany, type DeleteOne, type DistinctDocumentId, type DocumentWithId, ENCRYPTION_ALGORITHMS, type EstimatedDocumentCount, type Find, type FindCursor, type FindOne, type FindOneAndUpdate, type FindOneAndUpdateUpdateOptions, type InferIdType, type InferSchemaTypeWithId, type InitItem, type InsertAndFind, type InsertMany, type InsertManyOptions, type InsertOne, type InsertOptions, type ModelClassBase, type ModelToMongoSelector, MongoCollection, type MongoFilter, type MongoSelector, type OptionalId, Repository, type SchemaWithRequiredId, type TypedId, type UpdateAndFind, type UpdateItem, type UpdateMany, type UpdateOne, type UpdateOptions, type Upsert, allConnectionPromises, configureConnection, connections, createCollection, createIndexesPromises, getDBName, getMongoConnection, getOrCreateEncryptionKey, typedId };
+export { BaseCollection, Collection, type CollectionIndex, type CountDocuments, type CreateCollectionOptions, type CreateCollectionOptionsWithSchemaType, type CreateCollectionOptionsWithTypedSchema, DataLoader, type DeleteMany, type DeleteOne, type DistinctDocumentId, type DocumentWithId, ENCRYPTION_ALGORITHMS, type EstimatedDocumentCount, type Find, type FindCursor, type FindOne, type FindOneAndUpdate, type FindOneAndUpdateUpdateOptions, type InferIdType, type InferSchemaTypeWithId, type InitItem, type InsertAndFind, type InsertMany, type InsertManyOptions, type InsertOne, type InsertOptions, type ModelClassBase, type ModelToMongoSelector, MongoCollection, type MongoFilter, type MongoSelector, type OptionalId, Repository, type SchemaWithRequiredId, type TypedId, type UpdateAndFind, type UpdateItem, type UpdateMany, type UpdateOne, type UpdateOptions, type Upsert, allConnectionPromises, collectionsRegistry, configureConnection, connections, createCollection, createIndexesPromises, deleteAllUnusedIndexes, getDBName, getMongoConnection, getOrCreateEncryptionKey, getRegisteredCollections, registerCollection, typedId };

package/dist/index.d.ts

@@ -304,6 +304,65 @@ declare function createCollection<T extends TypedSchemaOnSchema & {
 }>(options: CreateCollectionOptionsWithTypedSchema<T>): Collection<InferSchemaType<T>>;
 declare function createCollection<T extends ModelClassBase>(options: CreateCollectionOptions<T>): Collection<T>;
 
+/**
+ * Result of the deleteUnusedIndexes operation
+ */
+interface DeleteUnusedIndexesResult {
+    /** Names of the indexes that were deleted */
+    deletedIndexes: string[];
+    /** Name of the collection that was cleaned */
+    collectionName: string;
+}
+
+/**
+ * Registry that tracks all collections created via createCollection().
+ * Maps connection name to a map of collection name to collection instance.
+ * When the same collection is registered multiple times, indexes are merged.
+ */
+declare const collectionsRegistry: Map<string, Map<string, Collection<ModelClassBase>>>;
+/**
+ * Registers a collection in the registry.
+ * Called automatically when a collection is created via createCollection().
+ * If the same collection name is registered multiple times, indexes are merged
+ * to support multiple createCollection() calls for the same collection.
+ * @param connectionName - The name of the MongoDB connection
+ * @param collection - The collection instance to register
+ */
+declare function registerCollection(connectionName: string, collection: Collection<ModelClassBase>): void;
+/**
+ * Gets all registered collections for a specific connection.
+ * @param connectionName - The name of the MongoDB connection (defaults to 'main')
+ * @returns Array of registered collections for the connection
+ */
+declare function getRegisteredCollections(connectionName?: string): Array<Collection<ModelClassBase>>;
+/**
+ * Deletes unused indexes from all registered collections for a connection.
+ * Iterates over all collections registered via createCollection() and
+ * removes indexes that exist in MongoDB but are not defined in the collection configuration.
+ *
+ * **Important**: This function waits for all pending index creation to complete before
+ * deleting any indexes, to avoid race conditions where an index being created might
+ * be incorrectly identified as unused.
+ *
+ * @param connectionName - The name of the MongoDB connection (defaults to 'main')
+ * @returns Array of results for each collection that had indexes deleted
+ *
+ * @example
+ * ```ts
+ * // Delete unused indexes from all collections on the main connection
+ * const results = await deleteAllUnusedIndexes()
+ *
+ * // Delete unused indexes from all collections on a specific connection
+ * const results = await deleteAllUnusedIndexes('secondary')
+ *
+ * // Log results
+ * for (const result of results) {
+ *   console.log(`${result.collectionName}: deleted ${result.deletedIndexes.length} indexes`)
+ * }
+ * ```
+ */
+declare function deleteAllUnusedIndexes(connectionName?: string): Promise<DeleteUnusedIndexesResult[]>;
+
 declare function getOrCreateEncryptionKey({ keyAltName, kmsProvider, masterKey, connectionName, keyVaultDatabase, keyVaultCollection, kmsProviders, }: {
     keyAltName: string;
     kmsProvider: keyof KMSProviders;
@@ -321,4 +380,4 @@ declare const ENCRYPTION_ALGORITHMS: {
     RANDOM: string;
 };
 
-export { BaseCollection, Collection, type CollectionIndex, type CountDocuments, type CreateCollectionOptions, type CreateCollectionOptionsWithSchemaType, type CreateCollectionOptionsWithTypedSchema, DataLoader, type DeleteMany, type DeleteOne, type DistinctDocumentId, type DocumentWithId, ENCRYPTION_ALGORITHMS, type EstimatedDocumentCount, type Find, type FindCursor, type FindOne, type FindOneAndUpdate, type FindOneAndUpdateUpdateOptions, type InferIdType, type InferSchemaTypeWithId, type InitItem, type InsertAndFind, type InsertMany, type InsertManyOptions, type InsertOne, type InsertOptions, type ModelClassBase, type ModelToMongoSelector, MongoCollection, type MongoFilter, type MongoSelector, type OptionalId, Repository, type SchemaWithRequiredId, type TypedId, type UpdateAndFind, type UpdateItem, type UpdateMany, type UpdateOne, type UpdateOptions, type Upsert, allConnectionPromises, configureConnection, connections, createCollection, createIndexesPromises, getDBName, getMongoConnection, getOrCreateEncryptionKey, typedId };
+export { BaseCollection, Collection, type CollectionIndex, type CountDocuments, type CreateCollectionOptions, type CreateCollectionOptionsWithSchemaType, type CreateCollectionOptionsWithTypedSchema, DataLoader, type DeleteMany, type DeleteOne, type DistinctDocumentId, type DocumentWithId, ENCRYPTION_ALGORITHMS, type EstimatedDocumentCount, type Find, type FindCursor, type FindOne, type FindOneAndUpdate, type FindOneAndUpdateUpdateOptions, type InferIdType, type InferSchemaTypeWithId, type InitItem, type InsertAndFind, type InsertMany, type InsertManyOptions, type InsertOne, type InsertOptions, type ModelClassBase, type ModelToMongoSelector, MongoCollection, type MongoFilter, type MongoSelector, type OptionalId, Repository, type SchemaWithRequiredId, type TypedId, type UpdateAndFind, type UpdateItem, type UpdateMany, type UpdateOne, type UpdateOptions, type Upsert, allConnectionPromises, collectionsRegistry, configureConnection, connections, createCollection, createIndexesPromises, deleteAllUnusedIndexes, getDBName, getMongoConnection, getOrCreateEncryptionKey, getRegisteredCollections, registerCollection, typedId };

package/dist/index.js

@@ -1280,6 +1280,74 @@ async function loadIndexes(collection) {
   return results;
 }
 
+// src/createCollection/collectionsRegistry.ts
+import { logger as logger4 } from "@orion-js/logger";
+var collectionsRegistry = /* @__PURE__ */ new Map();
+function indexesAreEqual(indexA, indexB) {
+  const nameA = getIndexName(indexA);
+  const nameB = getIndexName(indexB);
+  if (nameA && nameB) {
+    return nameA === nameB;
+  }
+  return keysMatch(
+    indexA.keys,
+    indexB.keys
+  );
+}
+function mergeIndexes(existingIndexes, newIndexes) {
+  const merged = [...existingIndexes];
+  for (const newIndex of newIndexes) {
+    const isDuplicate = existingIndexes.some((existing) => indexesAreEqual(existing, newIndex));
+    if (!isDuplicate) {
+      merged.push(newIndex);
+    }
+  }
+  return merged;
+}
+function registerCollection(connectionName, collection) {
+  if (!collectionsRegistry.has(connectionName)) {
+    collectionsRegistry.set(connectionName, /* @__PURE__ */ new Map());
+  }
+  const connectionMap = collectionsRegistry.get(connectionName);
+  const existingCollection = connectionMap.get(collection.name);
+  if (existingCollection) {
+    existingCollection.indexes = mergeIndexes(existingCollection.indexes, collection.indexes);
+  } else {
+    connectionMap.set(collection.name, collection);
+  }
+}
+function getRegisteredCollections(connectionName = "main") {
+  const connectionCollections = collectionsRegistry.get(connectionName);
+  if (!connectionCollections) {
+    return [];
+  }
+  return Array.from(connectionCollections.values());
+}
+async function deleteAllUnusedIndexes(connectionName = "main") {
+  const collections = getRegisteredCollections(connectionName);
+  if (collections.length === 0) {
+    logger4.warn(`No collections registered for connection "${connectionName}"`);
+    return [];
+  }
+  if (createIndexesPromises.length > 0) {
+    logger4.info("Waiting for pending index creation to complete before deleting unused indexes...");
+    await Promise.all(createIndexesPromises);
+  }
+  logger4.info(
+    `Deleting unused indexes from ${collections.length} collections on connection "${connectionName}"`
+  );
+  const results = [];
+  for (const collection of collections) {
+    const result = await collection.deleteUnusedIndexes();
+    if (result.deletedIndexes.length > 0) {
+      results.push(result);
+    }
+  }
+  const totalDeleted = results.reduce((sum, r) => sum + r.deletedIndexes.length, 0);
+  logger4.info(`Deleted ${totalDeleted} unused indexes from ${results.length} collections`);
+  return results;
+}
+
 // src/createCollection/getSchemaAndModel.ts
 import { clone as clone3 } from "@orion-js/helpers";
 Symbol.metadata ?? (Symbol.metadata = Symbol("Symbol.metadata"));
@@ -1312,7 +1380,7 @@ function getSchema(options) {
 }
 
 // src/createCollection/wrapMethods.ts
-import { logger as logger4 } from "@orion-js/logger";
+import { logger as logger5 } from "@orion-js/logger";
 function wrapMethods(collection) {
   const methodsWithPromises = [
     "findOne",
@@ -1348,7 +1416,7 @@ function wrapMethods(collection) {
         collection[methodName2] = (...args) => {
           collection.startConnection();
           if (!collection.rawCollection) {
-            logger4.error("Method called before connection was initialized", {
+            logger5.error("Method called before connection was initialized", {
               collectionName: collection.name,
               connectionName: collection.connectionName,
               methodName: methodName2
@@ -1458,6 +1526,7 @@ function createCollection(options) {
   }
   wrapMethods(mainCollection);
   wrapMethods(encryptedCollection);
+  registerCollection(connectionName, mainCollection);
   return mainCollection;
 }
 
@@ -1488,7 +1557,7 @@ function MongoCollection(options) {
 }
 
 // src/encrypted/getOrCreateEncryptionKey.ts
-import { logger as logger5 } from "@orion-js/logger";
+import { logger as logger6 } from "@orion-js/logger";
 import { ClientEncryption, MongoClient as MongoClient2 } from "mongodb";
 async function getOrCreateEncryptionKey({
   keyAltName,
@@ -1500,7 +1569,7 @@ async function getOrCreateEncryptionKey({
   kmsProviders
 }) {
   const keyVaultNamespace = `${keyVaultDatabase}.${keyVaultCollection}`;
-  logger5.info("Connecting to database to get or create the encryption key", {
+  logger6.info("Connecting to database to get or create the encryption key", {
     keyVaultNamespace,
     keyAltName
   });
@@ -1518,14 +1587,14 @@ async function getOrCreateEncryptionKey({
   });
   const key = await clientEncryption.getKeyByAltName(keyAltName);
   if (key) {
-    logger5.info("Key found on the key vault", {
+    logger6.info("Key found on the key vault", {
       keyVaultNamespace,
       keyAltName,
       UUID: key._id
     });
     return { key: key._id, keyVaultNamespace };
   }
-  logger5.info("Key not found on the key vault, creating a new one", {
+  logger6.info("Key not found on the key vault, creating a new one", {
     keyVaultNamespace,
     keyAltName
   });
@@ -1533,7 +1602,7 @@ async function getOrCreateEncryptionKey({
     keyAltNames: [keyAltName],
     ...masterKey ? { masterKey } : {}
   });
-  logger5.info("New encryption key created", {
+  logger6.info("New encryption key created", {
     keyVaultNamespace,
     keyAltName,
     UUID: newKey
@@ -1552,13 +1621,17 @@ export {
   MongoDB,
   Repository,
   allConnectionPromises,
+  collectionsRegistry,
   configureConnection,
   connections,
   createCollection,
   createIndexesPromises,
+  deleteAllUnusedIndexes,
   getDBName,
   getMongoConnection,
   getOrCreateEncryptionKey,
+  getRegisteredCollections,
+  registerCollection,
   typedId
 };
 //# sourceMappingURL=index.js.map