feat: initialize admin bro the nest way

Author: SimonB407

example-app/package.json

@@ -18,6 +18,8 @@
     "test:e2e": "jest --config ./test/jest-e2e.json"
   },
   "dependencies": {
+    "admin-bro": "^3.0.0-beta.12",
+    "@admin-bro/mongoose": "^1.0.0-beta.3",
     "@nestjs/common": "^6.7.2",
     "@nestjs/core": "^6.7.2",
     "@nestjs/mongoose": "^7.0.2",
@@ -33,6 +35,7 @@
     "@nestjs/testing": "^6.7.1",
     "@types/express": "^4.17.1",
     "@types/jest": "^24.0.18",
+    "@types/mongoose": "^5.7.36",
     "@types/node": "^12.7.5",
     "@types/supertest": "^2.0.8",
     "cypress": "^4.11.0",

example-app/src/app.controller.ts

@@ -1,4 +1,6 @@
 import { Controller, Get } from '@nestjs/common';
+import mongoose from 'mongoose';
+
 import { AppService } from './app.service';
 
 @Controller()

example-app/src/app.module.ts

@@ -1,22 +1,41 @@
 import { Module } from '@nestjs/common';
+import { MongooseModule, getModelToken } from '@nestjs/mongoose';
+import mongoose, { Model } from 'mongoose';
 
 import { AdminModule } from '../../src/index';
 
 import { AppController } from './app.controller';
 import { AppService } from './app.service';
+import { Admin } from './mongoose/admin-model';
+import { MongooseSchemasModule } from './mongoose/mongoose.module';
 
 @Module({
-  imports: [AdminModule.createAdminModule({
-    adminBroOptions: {
-      rootPath: '/admin',
-    },
-    // auth: {
-    //   authenticate: async () => new Promise(() => ({ email: 'mordeczka' })),
-    //   cookieName: 'test',
-    //   cookiePassword: 'testPass',
-    // },
-  })],
+  imports: [
+    MongooseModule.forRoot('mongodb://localhost:27017/nest'),
+    AdminModule.createAdminModule({
+      imports: [
+        MongooseSchemasModule,
+      ],
+      inject: [
+        getModelToken('Admin'),
+      ],
+      useFactory: (adminModel: Model<Admin>) => ({
+        adminBroOptions: {
+          rootPath: '/admin',
+          resources: [
+            { resource: adminModel },
+          ],
+        },
+        auth: {
+          authenticate: async () => new Promise(() => ({ email: 'mordeczka' })),
+          cookieName: 'test',
+          cookiePassword: 'testPass',
+        },
+      }),
+    }),
+    MongooseSchemasModule,
+  ],
   controllers: [AppController],
   providers: [AppService],
 })
-export class AppModule {}
+export class AppModule { }

example-app/src/main.ts

@@ -1,6 +1,11 @@
+import AdminBro from 'admin-bro';
+import AdminBroMongoose from '@admin-bro/mongoose';
 import { NestFactory } from '@nestjs/core';
+
 import { AppModule } from './app.module';
 
+AdminBro.registerAdapter(AdminBroMongoose);
+
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
   await app.listen(3000);

example-app/src/mongoose/admin-model.js

@@ -0,0 +1,19 @@
+import mongoose from 'mongoose';
+
+const { Schema } = mongoose
+
+export interface Admin extends mongoose.Document {
+  email: string,
+  password: string,
+}
+
+export const AdminSchema = new Schema({
+  email: {
+    type: String,
+    required: true,
+  },
+  password: {
+    type: String,
+    required: true,
+  },
+})

example-app/src/mongoose/admin-model.ts

@@ -0,0 +1,12 @@
+import { Module } from '@nestjs/common';
+import { MongooseModule } from '@nestjs/mongoose';
+
+import { AdminSchema } from './admin-model';
+
+@Module({
+  imports: [
+    MongooseModule.forFeature([{ name: 'Admin', schema: AdminSchema }]),
+  ],
+  exports: [MongooseModule],
+})
+export class MongooseSchemasModule {}

example-app/src/mongoose/mongoose.module.ts

@@ -2,6 +2,15 @@
 # yarn lockfile v1
 
 
+"@admin-bro/mongoose@^1.0.0-beta.3":
+  version "1.0.0-beta.3"
+  resolved "https://registry.yarnpkg.com/@admin-bro/mongoose/-/mongoose-1.0.0-beta.3.tgz#2c86b953b186d6490f6d40b7b18775834630c684"
+  integrity sha512-bPdJRIHszwBNmBu5cH6Dl+tN9Fq8dPAbKmw1chbf49csdhGem2lIxLFqlbwA+kF1r98o9Hk4kYHekaOJBnUdrw==
+  dependencies:
+    escape-regexp "0.0.1"
+    flat "^4.1.0"
+    lodash "^4.17.11"
+
 "@angular-devkit/core@7.3.8":
   version "7.3.8"
   resolved "https://registry.yarnpkg.com/@angular-devkit/core/-/core-7.3.8.tgz#702b0944a69c71cce3a1492e0d62de18df22a993"
@@ -573,6 +582,13 @@
     "@types/connect" "*"
     "@types/node" "*"
 
+"@types/bson@*":
+  version "4.0.2"
+  resolved "https://registry.yarnpkg.com/@types/bson/-/bson-4.0.2.tgz#7accb85942fc39bbdb7515d4de437c04f698115f"
+  integrity sha512-+uWmsejEHfmSjyyM/LkrP0orfE2m5Mx9Xel4tXNeqi1ldK5XMQcDsFkBmLDtuyKUbxj2jGDo0H240fbCRJZo7Q==
+  dependencies:
+    "@types/node" "*"
+
 "@types/color-name@^1.1.1":
   version "1.1.1"
   resolved "https://registry.yarnpkg.com/@types/color-name/-/color-name-1.1.1.tgz#1c1261bbeaa10a8055bbc5d8ab84b7b2afc846a0"
@@ -651,6 +667,22 @@
   resolved "https://registry.yarnpkg.com/@types/mime/-/mime-2.0.3.tgz#c893b73721db73699943bfc3653b1deb7faa4a3a"
   integrity sha512-Jus9s4CDbqwocc5pOAnh8ShfrnMcPHuJYzVcSUU7lrh8Ni5HuIqX3oilL86p3dlTrk0LzHRCgA/GQ7uNCw6l2Q==
 
+"@types/mongodb@*":
+  version "3.5.25"
+  resolved "https://registry.yarnpkg.com/@types/mongodb/-/mongodb-3.5.25.tgz#ab187db04d79f8e3f15af236327dc9139d9d4736"
+  integrity sha512-2H/Owt+pHCl9YmBOYnXc3VdnxejJEjVdH+QCWL5ZAfPehEn3evygKBX3/vKRv7aTwfNbUd0E5vjJdQklH/9a6w==
+  dependencies:
+    "@types/bson" "*"
+    "@types/node" "*"
+
+"@types/mongoose@^5.7.36":
+  version "5.7.36"
+  resolved "https://registry.yarnpkg.com/@types/mongoose/-/mongoose-5.7.36.tgz#2dae28c63041c6afba8a83ea02969f463b3f1021"
+  integrity sha512-ggFXgvkHgCNlT35B9d/heDYfSqOSwTmQjkRoR32sObGV5Xjd0N0WWuYlLzqeCg94j4hYN/OZxZ1VNNLltX/IVQ==
+  dependencies:
+    "@types/mongodb" "*"
+    "@types/node" "*"
+
 "@types/node@*":
   version "14.0.27"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-14.0.27.tgz#a151873af5a5e851b51b3b065c9e63390a9e0eb1"
@@ -2535,6 +2567,11 @@ escape-html@~1.0.3:
   resolved "https://registry.yarnpkg.com/escape-html/-/escape-html-1.0.3.tgz#0258eae4d3d0c0974de1c169188ef0051d1d1988"
   integrity sha1-Aljq5NPQwJdN4cFpGI7wBR0dGYg=
 
+escape-regexp@0.0.1:
+  version "0.0.1"
+  resolved "https://registry.yarnpkg.com/escape-regexp/-/escape-regexp-0.0.1.tgz#f44bda12d45bbdf9cb7f862ee7e4827b3dd32254"
+  integrity sha1-9EvaEtRbvfnLf4Yu5+SCez3TIlQ=
+
 escape-string-regexp@^1.0.2, escape-string-regexp@^1.0.5:
   version "1.0.5"
   resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4"
@@ -3080,6 +3117,13 @@ flat-cache@^2.0.1:
     rimraf "2.6.3"
     write "1.0.3"
 
+flat@^4.1.0:
+  version "4.1.0"
+  resolved "https://registry.yarnpkg.com/flat/-/flat-4.1.0.tgz#090bec8b05e39cba309747f1d588f04dbaf98db2"
+  integrity sha512-Px/TiLIznH7gEDlPXcUD4KnBusa6kR6ayRUVcnEAbreRIuhkqow/mun59BuRXwoYk7ZQOLW1ZM05ilIvK38hFw==
+  dependencies:
+    is-buffer "~2.0.3"
+
 flatted@^2.0.0:
   version "2.0.2"
   resolved "https://registry.yarnpkg.com/flatted/-/flatted-2.0.2.tgz#4575b21e2bcee7434aa9be662f4b7b5f9c2b5138"
@@ -3636,6 +3680,11 @@ is-buffer@^1.1.5:
   resolved "https://registry.yarnpkg.com/is-buffer/-/is-buffer-1.1.6.tgz#efaa2ea9daa0d7ab2ea13a97b2b8ad51fefbe8be"
   integrity sha512-NcdALwpXkTm5Zvvbk7owOUSvVvBKDgKP5/ewfXEznmQFfs4ZRmanOeKBTjRVjka3QFoN6XJ+9F3USqfHqTaU5w==
 
+is-buffer@~2.0.3:
+  version "2.0.4"
+  resolved "https://registry.yarnpkg.com/is-buffer/-/is-buffer-2.0.4.tgz#3e572f23c8411a5cfd9557c849e3665e0b290623"
+  integrity sha512-Kq1rokWXOPXWuaMAqZiJW4XxsmD9zGx9q4aePabbn3qCRGedtH7Cm+zV8WETitMfu1wdh+Rvd6w5egwSngUX2A==
+
 is-callable@^1.1.4, is-callable@^1.2.0:
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/is-callable/-/is-callable-1.2.0.tgz#83336560b54a38e35e3a2df7afd0454d691468bb"
@@ -4567,7 +4616,7 @@ lodash.toarray@^4.4.0:
   resolved "https://registry.yarnpkg.com/lodash.toarray/-/lodash.toarray-4.4.0.tgz#24c4bfcd6b2fba38bfd0594db1179d8e9b656561"
   integrity sha1-JMS/zWsvuji/0FlNsRedjptlZWE=
 
-lodash@^4.17.10, lodash@^4.17.14, lodash@^4.17.15, lodash@^4.17.19:
+lodash@^4.17.10, lodash@^4.17.11, lodash@^4.17.14, lodash@^4.17.15, lodash@^4.17.19:
   version "4.17.19"
   resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.19.tgz#e48ddedbe30b3321783c5b4301fbd353bc1e4a4b"
   integrity sha512-JNvd8XER9GQX0v2qJgsaN/mzFCNA5BRe/j8JN9d+tWyGLSodKQHKFicdwNYzWwI3wjRnaKPsGj1XkBjx/F96DQ==

example-app/yarn.lock

@@ -1,11 +1,12 @@
-import AdminBro, { AdminBroOptions } from 'admin-bro'
+import AdminBro from 'admin-bro'
 import { Module, DynamicModule, OnModuleInit, Inject } from '@nestjs/common'
 import { HttpAdapterHost } from '@nestjs/core'
 
 import { serveStaticProvider } from './serve-static.provider'
-import { ADMIN_BRO_TOKEN, CONFIG_TOKEN } from './token.constants'
+import { CONFIG_TOKEN } from './token.constants'
 import { AbstractLoader } from './loaders/abstract.loader'
 import { AdminModuleOptions } from './interfaces/admin-module-options.interface'
+import { AdminModuleFactory } from './interfaces/admin-module-factory.interface'
 
 @Module({
   providers: [serveStaticProvider],
@@ -14,41 +15,32 @@ export class AdminModule implements OnModuleInit {
   constructor(
     private readonly httpAdapterHost: HttpAdapterHost,
     private readonly loader: AbstractLoader,
-    @Inject(ADMIN_BRO_TOKEN)
-    private readonly adminBroInstance: AdminBro,
     @Inject(CONFIG_TOKEN)
     private readonly adminModuleOptions: AdminModuleOptions,
   ) {}
 
-  public static createAdminModule(adminModuleOptions: AdminModuleOptions): DynamicModule {
+  public static createAdminModule(options: AdminModuleFactory): DynamicModule {
     return {
+      imports: options.imports,
       module: AdminModule,
       providers: [
-        {
-          provide: ADMIN_BRO_TOKEN,
-          useFactory: async () => {
-            const admin = new AdminBro(adminModuleOptions.adminBroOptions);
-            await admin.initialize();
-
-            return admin;
-          },
-        },
         {
           provide: CONFIG_TOKEN,
-          useFactory: () => adminModuleOptions,
+          useFactory: options.useFactory,
+          inject: options.inject,
         },
       ],
-      exports: [
-        ADMIN_BRO_TOKEN,
-      ],
     }
   }
 
-  public onModuleInit() {
+  public async onModuleInit() {
+    const admin = new AdminBro(this.adminModuleOptions.adminBroOptions);
+    await admin.initialize();
+
     const { httpAdapter } = this.httpAdapterHost;
-    this.loader.register(this.adminBroInstance, httpAdapter, { 
+    this.loader.register(admin, httpAdapter, { 
       ...this.adminModuleOptions, 
-      adminBroOptions: this.adminBroInstance.options,
+      adminBroOptions: admin.options,
     });
   }
 }

src/admin.module.ts

@@ -0,0 +1,9 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { ModuleMetadata } from '@nestjs/common';
+
+import { AdminModuleOptions } from './admin-module-options.interface';
+
+export interface AdminModuleFactory extends Pick<ModuleMetadata, 'imports'> {
+  inject?: any[],
+  useFactory: (...args: any[]) => Promise<AdminModuleOptions> | AdminModuleOptions,
+}