Merge pull request #10 from inaiat/feat/add_indexes_specficiation/omurilo

feat: add a possible to register indexes for models

Author: inaiat

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inaiat/fastify-papr",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "Fastify Papr Plugin Integration",
   "type": "module",
   "engines": {

src/index.ts

@@ -1,5 +1,6 @@
 import fp from 'fastify-plugin'
 import type {BaseSchema, Model, SchemaOptions} from 'papr'
+import { IndexDescription } from 'mongodb'
 import type {FastifyPaprOptions, PaprModels} from './types.js'
 import {paprHelper} from './papr-helper.js'
 
@@ -12,10 +13,12 @@ export const asModel = <TSchema extends BaseSchema>(
   collectionSchema,
 })
 
+export const asIndexes = (collectionName: string, collectionIndexes: readonly IndexDescription[]) => ({collectionName, collectionIndexes})
+
 const fastifyPaprPlugin = fp<FastifyPaprOptions>(
   async (mutable_fastify, options) => {
     const helper = paprHelper(mutable_fastify, options.db, options.disableSchemaReconciliation)
-    const models = await helper.register(options.models)
+    const models = await helper.register(options.models, options.indexes)
     const {name} = options
     if (name) {
       if (!mutable_fastify.papr) {

src/papr-helper.ts

@@ -1,7 +1,7 @@
 import type {FastifyInstance} from 'fastify'
-import type {Db} from 'mongodb'
+import type {Db, IndexDescription} from 'mongodb'
 import Papr, {type Model, BaseSchema, SchemaOptions} from 'papr'
-import {type PaprModels, ModelRegistrationPair} from './types.js'
+import {type PaprModels, ModelRegistrationPair, IndexesRegistrationPair} from './types.js'
 
 export const paprHelper = (fastify: Readonly<FastifyInstance>, db: Db, disableSchemaReconciliation = false) => {
   const papr = new Papr()
@@ -21,14 +21,23 @@ export const paprHelper = (fastify: Readonly<FastifyInstance>, db: Db, disableSc
     return model
   }
 
+  const registerIndexes = async (collectionName: string, indexes: readonly IndexDescription[]) => db.collection(collectionName).createIndexes(indexes as IndexDescription[])
+
   return {
-    register: async (schemas: ModelRegistrationPair<PaprModels>): Promise<PaprModels> =>
-      Object.fromEntries(await Promise.all(
+    async register(schemas: ModelRegistrationPair<PaprModels>, indexes: IndexesRegistrationPair[] = []): Promise<PaprModels> {
+      indexes.map(async ({ collectionIndexes, collectionName}) => {
+        const index = await registerIndexes(collectionName, collectionIndexes)
+        fastify.log.info(`Indexes to ${collectionName} created`)
+        return index
+      })
+
+      return Object.fromEntries(await Promise.all(
         Object.entries(schemas).map(async ([modelName, modelObject]) => {
           const model = await registerModel(modelObject.collectionName, modelObject.collectionSchema)
           fastify.log.info(`Model ${modelName} decorated`)
           return [modelName, model] as [string, Model<BaseSchema, SchemaOptions<Partial<BaseSchema>>>]
-        }))),
-
+        }),
+      ))
+    },
   }
 }

src/types.ts

@@ -1,5 +1,5 @@
 import type {Model} from 'papr'
-import type {Db} from 'mongodb'
+import type {Db, IndexDescription} from 'mongodb'
 import type {asModel} from './index.js'
 
 export type PaprModelItem = ReturnType<typeof asModel>
@@ -8,6 +8,11 @@ export type ModelRegistrationPair<T> = {
   [U in keyof T]: PaprModelItem
 }
 
+export type IndexesRegistrationPair = {
+  collectionName: string;
+  collectionIndexes: IndexDescription[];
+}
+
 export type PaprModels = Record<string, Model<any, any>>
 
 export type FastifyPaprNestedObject = Record<string, PaprModels>
@@ -17,6 +22,7 @@ export type FastifyPaprOptions = {
   db: Db;
   models: ModelRegistrationPair<PaprModels>;
   disableSchemaReconciliation?: boolean;
+  indexes?: IndexesRegistrationPair[];
 }
 
 declare module 'fastify' {