chore: rebrand AdminBro to AdminJS

This commit is a part of AdminBro to AdminJS process.

BREAKING CHANGE: AdminBro has been rebranded to AdminJS. All package and repository names had been updated.
1. Update your dependencies to use new `adminjs` packages.
- `admin-bro` -> `adminjs` for the core package
- `@admin-bro/<package name>` -> `@adminjs/<package name>` for other modules
2. Update your custom CSS classes:
- `.admin-bro_<component name>` -> `.adminjs_<component name>` (example: `.adminjs_Box`)
3. Search your project for `admin-bro` occurrences - most likely they will have to be updated to `adminjs`

Author: dziraf

README.md

@@ -1,25 +1,25 @@
-# Expressjs plugin for AdminBro
+# Expressjs plugin for AdminJS
 
-This is an official [AdminBro](https://github.com/SoftwareBrothers/admin-bro) plugin which integrates it to [expressjs](https://expressjs.com/) framework.
+This is an official [AdminJS](https://github.com/SoftwareBrothers/adminjs) plugin which integrates it to [expressjs](https://expressjs.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://adminjs-example-app-staging.herokuapp.com/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 visit the [Express section under AdminBro project page](https://softwarebrothers.github.io/admin-bro-dev/module-admin-bro-expressjs.html)
+To see example usage visit the [Express section under AdminJS project page](https://softwarebrothers.github.io/adminjs-dev/module-adminjs-expressjs.html)
 
 ## Debugging
-Set `process.env.ADMIN_BRO_EXPRESS_DEBUG` env variable to see debug logs from the library
+Set `process.env.ADMINJS_EXPRESS_DEBUG` env variable to see debug logs from the library
 
 ## License
 
-AdminBro is Copyright © 2018 SoftwareBrothers.co. It is free software and may be redistributed under the terms specified in the [LICENSE](LICENSE) file.
+AdminJS is Copyright © 2021 SoftwareBrothers.co. It is free software and may be redistributed under the terms specified in the [LICENSE](LICENSE) file.
 
 ## About SoftwareBrothers.co
 

examples/auth.ts

@@ -1,13 +1,13 @@
-import AdminBro from "admin-bro";
+import AdminJS from "adminjs";
 import express from "express";
 import mongoose from "mongoose";
-import MongooseAdapter from "@admin-bro/mongoose";
-import AdminBroExpress from "../src";
+import MongooseAdapter from "@adminjs/mongoose";
+import AdminJSExpress from "../src";
 
 import "./mongoose/article-model";
 import "./mongoose/admin-model";
 
-AdminBro.registerAdapter(MongooseAdapter);
+AdminJS.registerAdapter(MongooseAdapter);
 
 const ADMIN = {
   email: "[email protected]",
@@ -20,12 +20,12 @@ const start = async () => {
   );
   const app = express();
 
-  const adminBro = new AdminBro({
+  const adminJs = new AdminJS({
     databases: [connection],
     rootPath: "/admin",
   });
 
-  const router = AdminBroExpress.buildAuthenticatedRouter(adminBro, {
+  const router = AdminJSExpress.buildAuthenticatedRouter(adminJs, {
     authenticate: async (email, password) => {
       if (ADMIN.password === password && ADMIN.email === email) {
         return ADMIN;
@@ -35,10 +35,10 @@ const start = async () => {
     cookiePassword: "somasd1nda0asssjsdhb21uy3g",
   });
 
-  app.use(adminBro.options.rootPath, router);
+  app.use(adminJs.options.rootPath, router);
 
   app.listen(process.env.PORT || 8080, () =>
-    console.log("AdminBro is under localhost:8080/admin")
+    console.log("AdminJS is running under localhost:8080/admin")
   );
 };
 

examples/simple.ts

@@ -1,13 +1,13 @@
-import AdminBro from "admin-bro";
+import AdminJS from "adminjs";
 import express from "express";
 import mongoose from "mongoose";
-import MongooseAdapter from "@admin-bro/mongoose";
+import MongooseAdapter from "@adminjs/mongoose";
 
-import AdminBroExpress from "../src";
+import AdminJSExpress from "../src";
 import "./mongoose/article-model";
 import "./mongoose/admin-model";
 
-AdminBro.registerAdapter(MongooseAdapter);
+AdminJS.registerAdapter(MongooseAdapter);
 
 const start = async () => {
   const connection = await mongoose.connect(
@@ -16,16 +16,16 @@ const start = async () => {
   );
   const app = express();
 
-  const adminBro = new AdminBro({
+  const adminJs = new AdminJS({
     databases: [connection],
     rootPath: "/admin",
   });
-  const router = AdminBroExpress.buildRouter(adminBro);
+  const router = AdminJSExpress.buildRouter(adminJs);
 
-  app.use(adminBro.options.rootPath, router);
+  app.use(adminJs.options.rootPath, router);
 
   app.listen(process.env.PORT || 8080, () =>
-    console.log("AdminBro is under localhost:8080/admin")
+    console.log("AdminJS is running under localhost:8080/admin")
   );
 };
 

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "@admin-bro/express",
+  "name": "@adminjs/express",
   "version": "3.1.0",
-  "description": "This is an official AdminBro plugin which integrates it to expressjs framework",
+  "description": "This is an official AdminJS plugin which integrates it with Express.js framework",
   "main": "lib/index.js",
   "scripts": {
     "dev": "rm -rf lib && tsc --watch",
@@ -15,22 +15,22 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/SoftwareBrothers/admin-bro-expressjs.git"
+    "url": "git+https://github.com/SoftwareBrothers/adminjs-expressjs.git"
   },
   "keywords": [
     "expressjs",
     "admin",
-    "adminbro",
+    "adminjs",
     "admin-panel"
   ],
   "author": "Michał Laskowski",
   "license": "SEE LICENSE IN LICENSE",
   "bugs": {
-    "url": "https://github.com/SoftwareBrothers/admin-bro-expressjs/issues"
+    "url": "https://github.com/SoftwareBrothers/adminjs-expressjs/issues"
   },
-  "homepage": "https://github.com/SoftwareBrothers/admin-bro-expressjs#readme",
+  "homepage": "https://github.com/SoftwareBrothers/adminjs-expressjs#readme",
   "peerDependencies": {
-    "admin-bro": ">=3.0.0",
+    "adminjs": ">=3.0.0",
     "express": ">=4.16.4",
     "express-formidable": "^1.2.0",
     "express-session": ">=1.15.6"
@@ -41,7 +41,7 @@
     }
   },
   "devDependencies": {
-    "@admin-bro/mongoose": "^1.1.0",
+    "@adminjs/mongoose": "^1.1.0",
     "@commitlint/config-conventional": "^11.0.0",
     "@semantic-release/git": "^9.0.0",
     "@types/express": "^4.17.9",
@@ -52,7 +52,7 @@
     "@types/mongoose": "^5.10.1",
     "@typescript-eslint/eslint-plugin": "^4.8.1",
     "@typescript-eslint/parser": "^4.8.1",
-    "admin-bro": "^3.3.1",
+    "adminjs": "^3.3.1",
     "chai": "^4.2.0",
     "commitlint": "^11.0.0",
     "eslint": "^7.13.0",

src/authentication/login.handler.ts

@@ -1,8 +1,8 @@
-import AdminBro from "admin-bro";
+import AdminJS from "adminjs";
 import { Router } from "express";
 import { AuthenticationOptions } from "../types";
 
-const getLoginPath = (admin: AdminBro): string => {
+const getLoginPath = (admin: AdminJS): string => {
   const { loginPath, rootPath } = admin.options;
   // since we are inside already namespaced router we have to replace login and logout routes that
   // they don't have rootUrl inside. So changing /admin/login to just /login.
@@ -17,7 +17,7 @@ const getLoginPath = (admin: AdminBro): string => {
 
 export const withLogin = (
   router: Router,
-  admin: AdminBro,
+  admin: AdminJS,
   auth: AuthenticationOptions
 ): void => {
   const { rootPath } = admin.options;

src/authentication/logout.handler.ts

@@ -1,7 +1,7 @@
-import AdminBro from "admin-bro";
+import AdminJS from "adminjs";
 import { Router } from "express";
 
-const getLogoutPath = (admin: AdminBro) => {
+const getLogoutPath = (admin: AdminJS) => {
   const { logoutPath, rootPath } = admin.options;
   const normalizedLogoutPath = logoutPath.replace(rootPath, "");
 
@@ -10,7 +10,7 @@ const getLogoutPath = (admin: AdminBro) => {
     : `/${normalizedLogoutPath}`;
 };
 
-export const withLogout = (router: Router, admin: AdminBro): void => {
+export const withLogout = (router: Router, admin: AdminJS): void => {
   const logoutPath = getLogoutPath(admin);
 
   router.get(logoutPath, async (request, response) => {

src/authentication/protected-routes.handler.ts

@@ -1,9 +1,9 @@
-import AdminBro, { Router as AdminRouter } from "admin-bro";
+import AdminJS, { Router as AdminRouter } from "adminjs";
 import { Router } from "express";
 
 export const withProtectedRoutesHandler = (
   router: Router,
-  admin: AdminBro
+  admin: AdminJS
 ): void => {
   const { rootPath } = admin.options;
 

src/buildAuthenticatedRouter.ts

@@ -1,4 +1,4 @@
-import AdminBro from "admin-bro";
+import AdminJS from "adminjs";
 import express, { Router } from "express";
 import session from "express-session";
 import { withLogout } from "./authentication/logout.handler";
@@ -11,7 +11,7 @@ import formidableMiddleware from "express-formidable";
 
 /**
  * @typedef {Function} Authenticate
- * @memberof module:@admin-bro/express
+ * @memberof module:@adminjs/express
  * @description
  * function taking 2 arguments email and password
  * @param {string} [email]         email given in the form
@@ -27,26 +27,26 @@ import formidableMiddleware from "express-formidable";
  * not optimized for production usage and, in development, it causes
  * logging out after every page refresh (if you use nodemon).
  * @static
- * @memberof module:@admin-bro/express
+ * @memberof module:@adminjs/express
  * @example
  * const ADMIN = {
  *   email: 'test@example.com',
  *   password: 'password',
  * }
  *
- * AdminBroExpress.buildAuthenticatedRouter(adminBro, {
+ * AdminJSExpress.buildAuthenticatedRouter(adminJs, {
  *   authenticate: async (email, password) => {
  *     if (ADMIN.password === password && ADMIN.email === email) {
  *       return ADMIN
  *     }
  *     return null
  *   },
- *   cookieName: 'adminbro',
+ *   cookieName: 'adminjs',
  *   cookiePassword: 'somePassword',
  * }, [router])
  */
 export const buildAuthenticatedRouter = (
-  admin: AdminBro,
+  admin: AdminJS,
   auth: AuthenticationOptions,
   predefinedRouter?: express.Router | null,
   sessionOptions?: session.SessionOptions,
@@ -65,7 +65,7 @@ export const buildAuthenticatedRouter = (
     session({
       ...sessionOptions,
       secret: auth.cookiePassword,
-      name: auth.cookieName || "adminbro",
+      name: auth.cookieName || "adminjs",
     })
   );
   router.use(formidableMiddleware(formidableOptions));

src/buildRouter.ts

@@ -1,33 +1,33 @@
-import AdminBro, { Router as AdminRouter } from "admin-bro";
+import AdminJS, { Router as AdminRouter } from "adminjs";
 import { RequestHandler, Router } from "express";
 import formidableMiddleware from "express-formidable";
 import path from "path";
 import { WrongArgumentError } from "./errors";
 import { log } from "./logger";
 import { FormidableOptions } from "./types";
 
-const INVALID_ADMIN_BRO_INSTANCE =
-  "You have to pass an instance of AdminBro to the buildRouter() function";
+const INVALID_ADMINJS_INSTANCE =
+  "You have to pass an instance of AdminJS to the buildRouter() function";
 
 export const buildRouter = (
-  admin: AdminBro,
+  admin: AdminJS,
   predefinedRouter?: Router | null,
   formidableOptions?: FormidableOptions
 ): Router => {
-  if (admin?.constructor?.name !== "AdminBro") {
-    throw new WrongArgumentError(INVALID_ADMIN_BRO_INSTANCE);
+  if (admin?.constructor?.name !== "AdminJS") {
+    throw new WrongArgumentError(INVALID_ADMINJS_INSTANCE);
   }
 
   admin.initialize().then(() => {
-    log.debug("AdminBro: bundle ready");
+    log.debug("AdminJS: bundle ready");
   });
 
   const { routes, assets } = AdminRouter;
   const router = predefinedRouter ?? Router();
   router.use(formidableMiddleware(formidableOptions));
 
   routes.forEach((route) => {
-    // we have to change routes defined in AdminBro from {recordId} to :recordId
+    // we have to change routes defined in AdminJS from {recordId} to :recordId
     const expressPath = route.path.replace(/{/g, ":").replace(/}/g, "");
 
     const handler: RequestHandler = async (req, res, next) => {

src/errors.ts

@@ -9,14 +9,14 @@ export class OldBodyParserUsedError extends Error {
   constructor(
     message = `
   You probably used old \`body-parser\` middleware, which is not compatible
-  with @admin-bro/express. In order to make it work you will have to
-  1. move body-parser invocation after the admin bro setup like this:
+  with @adminjs/express. In order to make it work you will have to
+  1. move body-parser invocation after the AdminJS setup like this:
   
-  const adminBro = new AdminBro()
-  const router = new buildRouter(adminBro)
-  app.use(adminBro.options.rootPath, router)
+  const adminJs = new AdminJS()
+  const router = new buildRouter(adminJs)
+  app.use(adminJs.options.rootPath, router)
   
-  // body parser goes after the AdminBro router
+  // body parser goes after the AdminJS router
   app.use(bodyParser())
   
   2. Upgrade body-parser to the latest version and use it like this: