chore: rebrand package from admin-bro to adminjs

Author: dziraf

.gitignore

@@ -159,7 +159,7 @@ dist
 types
 build
 lib
-.adminbro
+.adminjs
 
 example-app/.env
 *.log

README.md

@@ -1,33 +1,29 @@
-## admin-bro-mikroorm
+## adminjs-mikroorm
 
-This is an *unofficial* [admin-bro](https://github.com/SoftwareBrothers/admin-bro) adapter which integrates [MikroORM](https://github.com/mikro-orm/mikro-orm) into admin-bro.
-
-Note that this is a first release and it's currently tested using only the example setup found in this repository.
-
-If you are having trouble integrating this adapter in your project, please open an issue and try to describe the problem with as many details as possible.
+This is an official [AdminJS](https://github.com/SoftwareBrothers/adminjs) adapter which integrates [MikroORM](https://github.com/mikro-orm/mikro-orm) into AdminJS.
 
 ### Installation
 
 yarn
 ```bash
-$ yarn add admin-bro-mikroorm
+$ yarn add @adminjs/mikroorm
 ```
 
 npm
 ```bash
-$ npm i admin-bro-mikroorm
+$ npm i @adminjs/mikroorm
 ```
 
 ## Usage
 
-The plugin can be registered using standard `AdminBro.registerAdapter` method.
+The plugin can be registered using standard `AdminJS.registerAdapter` method.
 
 ```typescript
-import { Database, Resource } from 'admin-bro-mikroorm';
-import AdminBro from 'admin-bro';
+import { Database, Resource } from '@adminjs/mikroorm';
+import AdminJS from 'adminjs';
 import { validate } from 'class-validator';
 
-const setupAdminBro = async () => {
+const setupAdminJs = async () => {
   const orm = await MikroORM.init({
     entities: [User],
     dbName: process.env.DATABASE_NAME,
@@ -41,15 +37,15 @@ const setupAdminBro = async () => {
   Resource.setORM(orm);
   // If your entities use `class-validator` to validate data, you can inject it's validate method into the resource.
   Resource.validate = validate;
-  AdminBro.registerAdapter({ Database, Resource });
+  AdminJS.registerAdapter({ Database, Resource });
 
-  // You can instantiate AdminBro either by specifying all resources separately:
-  const adminBro = new AdminBro({
+  // You can instantiate AdminJS either by specifying all resources separately:
+  const adminJs = new AdminJS({
     resources: [{ resource: User, options: {} }],
   });
 
   // Or by passing your ORM instance into `databases` property.
-  const adminBro = new AdminBro({
+  const adminJs = new AdminJS({
     databases: [orm],
   });
   // You should choose to use either `resources` or `databases`
@@ -86,15 +82,15 @@ yarn link
 
 4. Setup example app
 
-Install all dependencies and use previously linked version of `admin-bro-mikroorm`.
+Install all dependencies and use previously linked version of `@adminjs/mikroorm`.
 
 ```
 cd example-app
 yarn install
-yarn link admin-bro-mikroorm
+yarn link "@adminjs/mikroorm"
 ```
 
-Optionally you might want to link your local version of `admin-bro` package
+Optionally you might want to link your local version of `adminjs` package
 
 5. Make sure you have all the envs set (see `./example-app/example.env` and create an `.env` file based on that)
 

example-app/package.json

@@ -19,11 +19,10 @@
     "typescript": "^4.2.3"
   },
   "dependencies": {
-    "@admin-bro/express": "^3.1.0",
+    "@adminjs/express": "^4.0.0",
     "@mikro-orm/core": "^4.5.0",
     "@mikro-orm/postgresql": "^4.5.0",
-    "admin-bro-mikroorm": "^1.0.0",
-    "admin-bro": "^3.4.0-beta.9",
+    "adminjs": "^5.2.2",
     "dotenv": "^8.2.0",
     "express": "^4.17.1",
     "express-formidable": "^1.2.0",

example-app/src/index.ts

@@ -5,9 +5,9 @@ import dotenv from 'dotenv';
 dotenv.config({ path: path.join(__dirname, '../.env') });
 /* eslint-disable import/first */
 import express from 'express';
-import AdminBro from 'admin-bro';
-import AdminBroExpress from '@admin-bro/express';
-import { Database, Resource } from 'admin-bro-mikroorm';
+import AdminJS from 'adminjs';
+import AdminJSExpress from '@adminjs/express';
+import { Database, Resource } from '@adminjs/mikroorm';
 import { MikroORM } from '@mikro-orm/core';
 
 import { User, Car, Seller } from './entities';
@@ -25,7 +25,7 @@ const run = async () => {
   });
 
   Resource.setORM(orm as any);
-  AdminBro.registerAdapter({ Database, Resource });
+  AdminJS.registerAdapter({ Database, Resource });
 
   const app = express();
 
@@ -57,12 +57,12 @@ const run = async () => {
     Seller,
   ];
 
-  const admin = new AdminBro({
+  const admin = new AdminJS({
     // databases: [orm],
     resources,
   });
 
-  const router = AdminBroExpress.buildRouter(admin);
+  const router = AdminJSExpress.buildRouter(admin);
 
   app.use(admin.options.rootPath, router);
 

example-app/tsconfig.json

@@ -17,7 +17,7 @@
       "sourceMap": true,
       "paths": {
         "react": ["node_modules/@types/react"],
-        "admin-bro": ["node_modules/admin-bro"],
+        "adminjs": ["node_modules/adminjs"],
       }
   },
   "include": [