Merge pull request #21 from SoftwareBrothers/feat/rebranding

chore: rebrand AdminBro to AdminJS

Author: dziraf

.gitignore

@@ -158,6 +158,6 @@ dist
 
 types
 build
-.adminbro
+.adminjs
 
 example-app/cypress/videos

README.md

@@ -1,22 +1,22 @@
-# NestJS plugin for AdminBro
+# NestJS plugin for AdminJS
 
-This is an official [AdminBro](https://github.com/SoftwareBrothers/admin-bro) plugin which integrates it to [nestjs](https://nestjs.com) framework.
+This is an official [AdminJS](https://github.com/SoftwareBrothers/adminjs) plugin which integrates it to [nestjs](https://nestjs.com) framework.
 
-## AdminBro
+## AdminJS
 
-AdminBro is an automatic admin interface which can be plugged into your application. You, as a developer, provide database models (like posts, comments, stores, products or whatever else your application uses), and AdminBro generates UI which allows you (or other trusted users) to manage content.
+AdminJS is an automatic admin interface which can be plugged into your application. You, as a developer, provide database models (like posts, comments, stores, products or whatever else your application uses), and AdminJS generates UI which allows you (or other trusted users) to manage content.
 
-Check out the example application with mongo and postgres models here: https://admin-bro-example-app-staging.herokuapp.com/admin
+Check out the example application with mongo and postgres models here: https://demo.adminjs.co/admin
 
-Or visit [AdminBro](https://github.com/SoftwareBrothers/admin-bro) github page.
+Or visit [AdminJS](https://github.com/SoftwareBrothers/adminjs) github page.
 
 ## Usage
 
-To see example usage see the [example-app](https://github.com/SoftwareBrothers/admin-bro-nestjs/tree/master/example-app) or visit the [Nestjs section under AdminBro project page](https://softwarebrothers.github.io/admin-bro-dev/module-admin-bro-nest.html)
+To see example usage see the [example-app](https://github.com/SoftwareBrothers/adminjs-nestjs/tree/master/example-app) or visit the [Nestjs section under AdminJS project page](https://softwarebrothers.github.io/adminjs-dev/module-adminjs-nest.html)
 
 ## License
 
-AdminBro is Copyright © 2020 SoftwareBrothers.co. It is free software, and may be redistributed under the terms specified in the [LICENSE](LICENSE.md) file.
+AdminJS is Copyright © 2020 SoftwareBrothers.co. It is free software, and may be redistributed under the terms specified in the [LICENSE](LICENSE.md) file.
 
 ## About SoftwareBrothers.co
 

example-app/package.json

@@ -18,13 +18,13 @@
     "test:e2e": "NODE_ENV=test jest --config ./test/jest-e2e.json"
   },
   "dependencies": {
-    "@admin-bro/express": "^3.0.1",
-    "@admin-bro/mongoose": "^1.1.0",
+    "@adminjs/express": "^3.0.1",
+    "@adminjs/mongoose": "^1.1.0",
     "@nestjs/common": "^7.4.2",
     "@nestjs/core": "7.4.2",
     "@nestjs/mongoose": "^7.0.2",
     "@nestjs/platform-express": "^6.7.2",
-    "admin-bro": "^3.3.1",
+    "adminjs": "^3.3.1",
     "class-transformer": "^0.3.1",
     "class-validator": "^0.12.2",
     "express": "^4.17.1",

example-app/src/app.module.ts

@@ -1,7 +1,7 @@
 import { Module } from '@nestjs/common';
 import { MongooseModule, getModelToken } from '@nestjs/mongoose';
-import AdminBro from 'admin-bro';
-import AdminBroMongoose from '@admin-bro/mongoose';
+import AdminJS from 'adminjs';
+import AdminJSMongoose from '@adminjs/mongoose';
 import { Model } from 'mongoose';
 
 import { AdminModule } from '../../src'; // lib
@@ -12,7 +12,7 @@ import { ExpressCustomLoader } from './express-custom.loader';
 import { Admin } from './mongoose/admin-model';
 import { MongooseSchemasModule } from './mongoose/mongoose.module';
 
-AdminBro.registerAdapter(AdminBroMongoose);
+AdminJS.registerAdapter(AdminJSMongoose);
 
 @Module({
   imports: [
@@ -25,7 +25,7 @@ AdminBro.registerAdapter(AdminBroMongoose);
         getModelToken('Admin'),
       ],
       useFactory: (adminModel: Model<Admin>) => ({
-        adminBroOptions: {
+        adminJsOptions: {
           rootPath: '/admin',
           resources: [
             { resource: adminModel },

example-app/src/express-custom.loader.ts

@@ -1,5 +1,5 @@
 /* eslint-disable no-underscore-dangle */
-import AdminBro from 'admin-bro';
+import AdminJS from 'adminjs';
 import { Injectable } from '@nestjs/common';
 import { AbstractHttpAdapter } from '@nestjs/core';
 
@@ -10,7 +10,7 @@ import { ExpressLoader } from '../../src/loaders/express.loader';
 @Injectable()
 export class ExpressCustomLoader extends AbstractLoader {
   public register(
-    admin: AdminBro,
+    admin: AdminJS,
     httpAdapter: AbstractHttpAdapter,
     options: AdminModuleOptions,
   ) {

package.json

@@ -1,10 +1,10 @@
 {
-  "name": "@admin-bro/nestjs",
+  "name": "@adminjs/nestjs",
   "version": "1.1.0",
   "main": "build/index.js",
   "types": "types/index.d.ts",
   "private": false,
-  "repository": "git@github.com:SoftwareBrothers/admin-bro-nestjs.git",
+  "repository": "git@github.com:SoftwareBrothers/adminjs-nestjs.git",
   "license": "MIT",
   "scripts": {
     "release": "semantic-release",
@@ -18,15 +18,15 @@
     }
   },
   "peerDependencies": {
-    "admin-bro": ">=3.0.0"
+    "adminjs": ">=3.0.0"
   },
   "devDependencies": {
     "@commitlint/cli": "^8.3.5",
     "@commitlint/config-conventional": "^8.3.4",
     "@semantic-release/git": "^9.0.0",
     "@typescript-eslint/eslint-plugin": "^3.7.0",
     "@typescript-eslint/parser": "^3.7.0",
-    "admin-bro": "^3.3.1",
+    "adminjs": "^5.0.0",
     "eslint": "^7.5.0",
     "eslint-config-airbnb": "^18.2.0",
     "eslint-plugin-import": "^2.22.0",

src/admin.module.ts

@@ -1,4 +1,4 @@
-import AdminBro from 'admin-bro'
+import AdminJS from 'adminjs'
 import { Module, DynamicModule, OnModuleInit, Inject } from '@nestjs/common'
 import { HttpAdapterHost } from '@nestjs/core'
 
@@ -10,14 +10,14 @@ import { AdminModuleFactory } from './interfaces/admin-module-factory.interface'
 import { CustomLoader } from './interfaces/custom-loader.interface'
 
 /**
- * Nest module which is responsible for an AdminBro integration
+ * Nest module which is responsible for an AdminJS integration
  * 
  * @summary Nest Module
  * 
  * @class
- * @name module:@admin-bro/nestjs~AdminModule
+ * @name module:@adminjs/nestjs~AdminModule
  * @alias AdminModule
- * @memberof module:@admin-bro/nestjs
+ * @memberof module:@adminjs/nestjs
  */
 // This is needed by JSDoc which cannot parse this statement
 @Module({})
@@ -33,12 +33,12 @@ export class AdminModule implements OnModuleInit {
    * Creates admin in a synchronous way
    * 
    * @param {AdminModuleOptions} options
-   * @memberof module:@admin-bro/nestjs~AdminModule
+   * @memberof module:@adminjs/nestjs~AdminModule
    * @method
    * @name createAdmin
    * @example
    * import { Module } from '@nestjs/common';
-   * import { AdminModule } from '@admin-bro/nestjs';
+   * import { AdminModule } from '@adminjs/nestjs';
    * 
    * \@Module({
    *   imports: [
@@ -72,7 +72,7 @@ export class AdminModule implements OnModuleInit {
    * Creates admin in an asynchronous way
    * 
    * @param {AdminModuleFactory} options
-   * @memberof module:@admin-bro/nestjs~AdminModule
+   * @memberof module:@adminjs/nestjs~AdminModule
    * @method
    * @name createAdminAsync
    * @example
@@ -87,7 +87,7 @@ export class AdminModule implements OnModuleInit {
    *         getModelToken('Admin'), // using mongoose function to inject dependency
    *       ],
    *       useFactory: (adminModel: Model<Admin>) => ({ // injected dependecy will appear as an argument
-   *         adminBroOptions: {
+   *         adminJsOptions: {
    *           rootPath: '/admin',
    *           resources: [
    *             { resource: adminModel },
@@ -119,19 +119,19 @@ export class AdminModule implements OnModuleInit {
   }
 
   /**
-   * Applies given options to AdminBro and initializes it
+   * Applies given options to AdminJS and initializes it
    */
   public onModuleInit() {
     if ('shouldBeInitialized' in this.adminModuleOptions && !this.adminModuleOptions.shouldBeInitialized) {
       return;
     }
 
-    const admin = new AdminBro(this.adminModuleOptions.adminBroOptions);
+    const admin = new AdminJS(this.adminModuleOptions.adminJsOptions);
 
     const { httpAdapter } = this.httpAdapterHost;
     this.loader.register(admin, httpAdapter, { 
       ...this.adminModuleOptions, 
-      adminBroOptions: admin.options,
+      adminJsOptions: admin.options,
     });
   }
 }

src/index.ts

@@ -1,25 +1,25 @@
 /**
- * @module @admin-bro/nestjs
+ * @module @adminjs/nestjs
  * @subcategory Plugins
  * @section modules
  * 
  * @classdesc
- * This is an official plugin which allows you to render AdminBro in [NestJS
+ * This is an official plugin which allows you to render AdminJS in [NestJS
  * framework](https://nestjs.com/)
  * 
  * ## Installation
  * 
- * 1. First of all, install the AdminBro along with the module:
+ * 1. First of all, install the AdminJS along with the module:
  * 
  * ```
- * yarn add admin-bro @admin-bro/nestjs
+ * yarn add adminjs @adminjs/nestjs
  * ```
  * 
  * ### Express:
- * You have to additionally add admin-bro express plugin along with packages it's using, express and express formidable:
+ * You have to additionally add adminjs express plugin along with packages it's using, express and express formidable:
  * 
  * ```
- * yarn add express @admin-bro/express express-formidable
+ * yarn add express @adminjs/express express-formidable
  * ```
  * 
  * If you are passing `authenticate` object you have to also add express-session:
@@ -36,12 +36,12 @@
  * 
  * ```
  * import { Module } from '@nestjs/common';
- * import { AdminModule } from '@admin-bro/nestjs';
+ * import { AdminModule } from '@adminjs/nestjs';
  * 
  * \@Module({
  *   imports: [
  *     AdminModule.createAdmin({
- *       adminBroOptions: {
+ *       adminJsOptions: {
  *         rootPath: '/admin',
  *         resources: [],
  *       }),
@@ -51,25 +51,25 @@
  * export class AppModule {}
  * ```
  * 
- * Then enter `/admin` path in your browser and you should see the AdminBro.
+ * Then enter `/admin` path in your browser and you should see the AdminJS.
  * 
  * 3. Passing resources
  * 
  * Let say you use @nestjs/typeorm module, and you have users module.
  * 
- * - you have to install @admin-bro/typeorm adapter
- * - you have to register it in AdminBro (as stated in the docs)
+ * - you have to install @adminjs/typeorm adapter
+ * - you have to register it in AdminJS (as stated in the docs)
  * - and you have to pass it to your options
  * 
  * ```
- * import AdminBro from 'admin-bro';
+ * import AdminJS from 'adminjs';
  * import { Module } from '@nestjs/common';
- * import { AdminModule } from '@admin-bro/nestjs';
- * import { Database, Resource } from '@admin-bro/typeorm'
+ * import { AdminModule } from '@adminjs/nestjs';
+ * import { Database, Resource } from '@adminjs/typeorm'
  * import { TypeOrmModule } from '@nestjs/typeorm';
  * import { UsersModule } from './users/users.module';
  * 
- * AdminBro.registerAdapter({ Database, Resource })
+ * AdminJS.registerAdapter({ Database, Resource })
  * 
  * \@Module({
  *   imports: [
@@ -85,7 +85,7 @@
  *       synchronize: true,
  *     }),
  *     AdminModule.createAdmin({
- *       adminBroOptions: {
+ *       adminJsOptions: {
  *          rootPath: '/admin',
  *          resources: [User],
  *       }
@@ -97,7 +97,7 @@
  * 
  * ## Authentication
  * 
- * Apart from the `adminBroOptions` you can define `auth` settings.
+ * Apart from the `adminJsOptions` you can define `auth` settings.
  * 
  * This is an example which always logs users in, since authenticate method
  * always returns a Promise resolving to {@link CurrentAdmin}. You may
@@ -106,7 +106,7 @@
  * 
  * ```
  * AdminModule.createAdmin({
- *     adminBroOptions: {
+ *     adminJsOptions: {
  *       rootPath: '/admin',
  *       resources: [User],
  *     },
@@ -138,7 +138,7 @@
  * })
  * export class MongooseSchemasModule {} 
  * ```
- * - we want to use Admin model in admin-bro panel, to be displayed as the resource
+ * - we want to use Admin model in adminjs panel, to be displayed as the resource
  * ```
  * \@Module({
  *    imports: [
@@ -151,7 +151,7 @@
  *          getModelToken('Admin'), // using mongoose function to inject dependency
  *        ],
  *        useFactory: (adminModel: Model<Admin>) => ({ // injected dependecy will appear as an argument
- *          adminBroOptions: {
+ *          adminJsOptions: {
  *            rootPath: '/admin',
  *            resources: [
  *              { resource: adminModel },
@@ -166,9 +166,9 @@
  * ```
  * 
  * ## Custom loader
- * In most cases default plugins for admin-bro are enough for functionality we need, but in rare ocasions 
+ * In most cases default plugins for adminjs are enough for functionality we need, but in rare ocasions 
  * we want to customize routing, or achieve different logic after login and this cases can be achieved only
- * by providing own plugin implementation. Because @admin-bro/nestjs under the hood uses plugin for express (@admin-bro/express)
+ * by providing own plugin implementation. Because @adminjs/nestjs under the hood uses plugin for express (@adminjs/express)
  * it would require basically copying whole nestjs plugin and express plugin to own project to put any changes.
  * Instead there is optional parameter to put your custom loader if you don't want to use official one for any reason.
  * Your custom loader must extend AbstractLoader.
@@ -177,7 +177,7 @@
  * \@Injectable()
  * export class CustomLoader extends AbstractLoader {
  *   public register(
- *     admin: AdminBro,
+ *     admin: AdminJS,
  *     httpAdapter: AbstractHttpAdapter,
  *     options: AdminModuleOptions,
  *   ) {}
@@ -188,7 +188,7 @@
  * 
  * ```
  * AdminModule.createAdmin({
- *     adminBroOptions: {
+ *     adminJsOptions: {
  *       //...
  *     },
  *     auth: {
@@ -208,7 +208,7 @@
  * ```
  * 
  * ## Example
- * There is a working example [here](https://github.com/SoftwareBrothers/admin-bro-nestjs/tree/master/example-app)
+ * There is a working example [here](https://github.com/SoftwareBrothers/adminjs-nestjs/tree/master/example-app)
  */
 import * as NestJSPlugin from './admin.module'