@xyo-network/module-abstract-mongodb 2.75.6 → 2.75.7

package/package.json

@@ -14,14 +14,14 @@
     "@xylabs/exists": "^2.12.14",
     "@xylabs/lodash": "^2.12.14",
     "@xylabs/static-implements": "^2.12.14",
-    "@xyo-network/module-model": "~2.75.6",
-    "@xyo-network/module-model-mongodb": "~2.75.6",
-    "@xyo-network/node-core-model": "~2.75.6",
-    "@xyo-network/payload-model": "~2.75.6",
+    "@xyo-network/module-model": "~2.75.7",
+    "@xyo-network/module-model-mongodb": "~2.75.7",
+    "@xyo-network/node-core-model": "~2.75.7",
+    "@xyo-network/payload-model": "~2.75.7",
     "mongodb": "^6.1.0"
   },
   "peerDependencies": {
-    "@xyo-network/sdk-xyo-mongo-js": "~2.75.6"
+    "@xyo-network/sdk-xyo-mongo-js": "~2.75.7"
   },
   "peerDependenciesMeta": {
     "@xyo-network/sdk-xyo-mongo-js": {
@@ -29,9 +29,9 @@
     }
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^3.0.80",
-    "@xylabs/tsconfig": "^3.0.80",
-    "@xyo-network/sdk-xyo-mongo-js": "~2.75.6",
+    "@xylabs/ts-scripts-yarn3": "^3.0.82",
+    "@xylabs/tsconfig": "^3.0.82",
+    "@xyo-network/sdk-xyo-mongo-js": "~2.75.7",
     "fake-indexeddb": "^4.0.2",
     "typescript": "^5.2.2"
   },
@@ -78,5 +78,5 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
   },
   "sideEffects": false,
-  "version": "2.75.6"
+  "version": "2.75.7"
 }

package/src/IndexDescription.ts

@@ -0,0 +1,26 @@
+/**
+ * The index direction (1 for ascending, -1 for descending)
+ */
+export type IndexDirection = -1 | 1
+
+/**
+ * Description of index(es) to be created on a store
+ */
+export type IndexDescription = {
+  /**
+   * The key(s) to index
+   */
+  key:
+    | {
+        [key: string]: IndexDirection
+      }
+    | Map<string, IndexDirection>
+  /**
+   * The name of the index
+   */
+  name?: string
+  /**
+   * If true, the index must enforce uniqueness on the key
+   */
+  unique?: boolean
+}

package/src/Module.ts

@@ -8,6 +8,7 @@ import { BaseMongoSdk, BaseMongoSdkConfig } from '@xyo-network/sdk-xyo-mongo-js'
 
 import { COLLECTIONS } from './Collections'
 import { getBaseMongoSdkPrivateConfig } from './config'
+import { IndexDescription } from './IndexDescription'
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type AnyAbstractModule<TParams extends MongoDBModuleParams = MongoDBModuleParams> = abstract new (...args: any[]) => Module<TParams>
@@ -51,6 +52,26 @@ export const MongoDBModuleMixin = <
       this._payloadSdk = this._payloadSdk ?? new BaseMongoSdk<PayloadWithMeta>(this.payloadSdkConfig)
       return assertEx(this._payloadSdk)
     }
+
+    /**
+     * Ensures any indexes specified within the config are created. This method should be idempotent
+     * allowing for multiple calls without causing errors while ensuring the desired state.
+     */
+    async ensureIndexes(): Promise<void> {
+      const configIndexes = (this.config as { storage?: { indexes?: IndexDescription[] } })?.storage?.indexes ?? []
+      await this.boundWitnesses.useCollection(async (collection) => {
+        const collectionName = collection.collectionName.toLowerCase()
+        const indexes = configIndexes.filter((ix) => ix?.name?.toLowerCase().startsWith(collectionName))
+        if (indexes.length === 0) return
+        await collection.createIndexes(indexes)
+      })
+      await this.payloads.useCollection(async (collection) => {
+        const collectionName = collection.collectionName.toLowerCase()
+        const indexes = configIndexes.filter((ix) => ix?.name?.toLowerCase().startsWith(collectionName))
+        if (indexes.length === 0) return
+        await collection.createIndexes(indexes)
+      })
+    }
   }
   return MongoModuleBase
 }

package/src/index.ts

@@ -2,6 +2,7 @@ export * from './Collections'
 export * from './config'
 export * from './Databases'
 export * from './Defaults'
+export * from './IndexDescription'
 export * from './Indexes'
 export * from './Module'
 export * from './util'