Merge pull request #81 from SoftwareBrothers/feat/rebrand

dziraf · web-flow · commit 4097b2a1222e · 2021-06-18T18:15:49.000+02:00
chore: rebrand AdminBro to AdminJS
diff --git a/.env-example b/.env-example
@@ -1,6 +1,6 @@
 NODE_ENV=test
-POSTGRES_USER="adminbro"
-POSTGRES_PASSWORD="adminbro"
-POSTGRES_DATABASE="adminbro-sequelize-test"
+POSTGRES_USER="adminjs"
+POSTGRES_PASSWORD="adminjs"
+POSTGRES_DATABASE="adminjs-sequelize-test"
 POSTGRES_HOST
 POSTGRES_PORT
diff --git a/README.md b/README.md
@@ -1,19 +1,19 @@
-## admin-bro-sequelizejs
+## adminjs-sequelizejs
 
-This is an official [AdminBro](https://github.com/SoftwareBrothers/admin-bro) adapter which integrates [sequelize ORM](http://docs.sequelizejs.com/) into admin-bro.
+This is an official [AdminJS](https://github.com/SoftwareBrothers/adminjs) adapter which integrates [sequelize ORM](http://docs.sequelizejs.com/) into AdminJS.
 
 ## Usage
 
-The plugin can be registered using standard `AdminBro.registerAdapter` method.
+The plugin can be registered using standard `AdminJS.registerAdapter` method.
 
 ```javascript
-const AdminBro = require('admin-bro')
-const AdminBroSequelize = require('@admin-bro/sequelize')
+const AdminJS = require('adminjs')
+const AdminJSSequelize = require('@adminjs/sequelize')
 
-AdminBro.registerAdapter(AdminBroSequelize)
+AdminJS.registerAdapter(AdminJSSequelize)
 ```
 
-More options can be found on [AdminBro](https://github.com/SoftwareBrothers/admin-bro) official website.
+More options can be found on [AdminJS](https://github.com/SoftwareBrothers/adminjs) official website.
 
 ## Testing
 
@@ -29,7 +29,7 @@ npm run sequelize db:migrate
 
 ## 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
 
diff --git a/example-app/.adminbro/.entry.js b/example-app/.adminbro/.entry.js
@@ -1 +1 @@
-AdminBro.UserComponents = {}
+AdminJS.UserComponents = {}
diff --git a/example-app/.adminbro/bundle.js b/example-app/.adminbro/bundle.js
diff --git a/example-app/.env-example b/example-app/.env-example
@@ -1,4 +1,4 @@
 NODE_ENV=test
-POSTGRES_USER="adminbro"
-POSTGRES_PASSWORD="adminbro"
-POSTGRES_DATABASE="adminbro-sequelize"
+POSTGRES_USER="adminjs"
+POSTGRES_PASSWORD="adminjs"
+POSTGRES_DATABASE="adminjs-sequelize"
diff --git a/example-app/package.json b/example-app/package.json
@@ -20,9 +20,9 @@
     "wait-on": "^5.2.0"
   },
   "dependencies": {
-    "@admin-bro/express": "^3.0.0",
-    "@admin-bro/sequelize": "1.0.0-beta.5",
-    "admin-bro": "^3.1.1",
+    "@adminjs/express": "^3.0.0",
+    "@adminjs/sequelize": "1.0.0-beta.5",
+    "adminjs": "^3.1.1",
     "dotenv": "^8.2.0",
     "express": "^4.17.1",
     "express-formidable": "^1.2.0",
diff --git a/example-app/src/connect.ts b/example-app/src/connect.ts
@@ -4,10 +4,10 @@ import buildUser from './users/user.entity'
 import buildComment from './comments/comment.entity'
 
 const connect = async (): Promise<Sequelize> => {
-  const dbName = process.env.POSTGRES_DATABASE || 'adminbro-sequelize'
+  const dbName = process.env.POSTGRES_DATABASE || 'adminjs-sequelize'
   const host = process.env.POSTGRES_HOST || 'localhost'
-  const password = process.env.POSTGRES_PASSWORD || 'adminbro'
-  const user = process.env.POSTGRES_USER || 'adminbro'
+  const password = process.env.POSTGRES_PASSWORD || 'adminjs'
+  const user = process.env.POSTGRES_USER || 'adminjs'
   const port = process.env.POSTGRES_PORT || 5432
 
   const sequelize = new Sequelize(
diff --git a/example-app/src/index.ts b/example-app/src/index.ts
@@ -5,21 +5,21 @@ import { config } from 'dotenv'
 config({ path: path.join(__dirname, '../../.env') })
 
 import express from 'express'
-import AdminBro from 'admin-bro'
-import { buildRouter } from '@admin-bro/express'
-import AdminBroSequelize from '@admin-bro/sequelize'
+import AdminJS from 'adminjs'
+import { buildRouter } from '@adminjs/express'
+import AdminJSSequelize from '@adminjs/sequelize'
 
 import userAdmin from './users/user.admin'
 
 import connect from './connect'
 
 const PORT = 3000
 
-AdminBro.registerAdapter(AdminBroSequelize)
+AdminJS.registerAdapter(AdminJSSequelize)
 const run = async () => {
   const sequelize = await connect()
   const app = express()
-  const admin = new AdminBro({
+  const admin = new AdminJS({
     databases: [sequelize],
     resources: [{
       resource: sequelize.models.User,
diff --git a/example-app/src/users/user.admin.ts b/example-app/src/users/user.admin.ts
@@ -1,4 +1,4 @@
-import { ResourceOptions } from 'admin-bro'
+import { ResourceOptions } from 'adminjs'
 
 const options: ResourceOptions = {
   properties: {
diff --git a/example-app/tsconfig.json b/example-app/tsconfig.json
@@ -16,7 +16,7 @@
     "types": ["cypress"],
     "paths": {
       "react": ["node_modules/@types/react"],
-      "admin-bro": ["node_modules/admin-bro"],
+      "adminjs": ["node_modules/adminjs"],
     },
     "baseUrl": "."
   },
diff --git a/index.js b/index.js
@@ -1,41 +1,41 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
 /**
- * @module @admin-bro/sequelize
+ * @module @adminjs/sequelize
  * @subcategory Adapters
  * @section modules
  *
  * @description
- * ### A Sequelize database adapter for AdminBro.
+ * ### A Sequelize database adapter for AdminJS.
  *
  * #### Installation
  *
  * To install the adapter run
  *
  * ```
- * yarn add @admin-bro/sequelize
+ * yarn add @adminjs/sequelize
  * ```
  *
  * ### Usage
  *
  * In order to use it in your project register the adapter first:
  *
  * ```javascript
- * const AdminBro = require('admin-bro')
- * const AdminBroSequelize = require('@admin-bro/sequelize')
+ * const AdminJS = require('adminjs')
+ * const AdminJSSequelize = require('@adminjs/sequelize')
  *
- * AdminBro.registerAdapter(AdminBroSequelize)
+ * AdminJS.registerAdapter(AdminJSSequelize)
  * ```
  *
  * ### Passing an entire database
  *
  * Sequelize generates folder in your app called `./models` and there is an `index.js` file.
- * You can require it and pass to {@link AdminBroOptions} like this:
+ * You can require it and pass to {@link AdminJSOptions} like this:
  *
  * ```javascript
  * const db = require('../models');
- * const AdminBro = new AdminBro({
+ * const AdminJS = new AdminJS({
  *   databases: [db],
- *   //... other AdminBroOptions
+ *   //... other AdminJSOptions
  * })
  * //...
  * ```
@@ -57,7 +57,7 @@
  *
  * ```javascript
  * const db = require('../models');
- * const AdminBro = new AdminBro({
+ * const AdminJS = new AdminJS({
  *   databases: [db], // you can still load an entire database and adjust just one resource
  *   resources: [{
  *     resource: db.vendor,
@@ -75,7 +75,7 @@
 /**
  * Implementation of {@link BaseDatabase} for Sequelize Adapter
  *
- * @memberof module:@admin-bro/sequelize
+ * @memberof module:@adminjs/sequelize
  * @type {typeof BaseDatabase}
  * @static
  */
@@ -84,7 +84,7 @@ const Database = require('./build/database').default
 /**
  * Implementation of {@link BaseResource} for Sequelize Adapter
  *
- * @memberof module:@admin-bro/sequelize
+ * @memberof module:@adminjs/sequelize
  * @type {typeof BaseResource}
  * @static
  */
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "@admin-bro/sequelize",
+  "name": "@adminjs/sequelize",
   "version": "1.2.1",
-  "description": "Sequelize adapter for AdminBro",
+  "description": "Sequelize adapter for AdminJS",
   "main": "build/index.js",
   "types": "index.d.ts",
   "scripts": {
@@ -16,12 +16,12 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/SoftwareBrothers/admin-bro-sequelizejs.git"
+    "url": "git+https://github.com/SoftwareBrothers/adminjs-sequelizejs.git"
   },
   "author": "Wojciech Krysiak",
   "license": "MIT",
   "peerDependencies": {
-    "admin-bro": ">=3.0.0",
+    "adminjs": ">=5.0.0",
     "sequelize": ">=4"
   },
   "husky": {
@@ -39,7 +39,7 @@
     "@types/sinon-chai": "^3.2.4",
     "@typescript-eslint/eslint-plugin": "^3.7.0",
     "@typescript-eslint/parser": "^3.7.0",
-    "admin-bro": "^3.2.3",
+    "adminjs": "^5.0.0",
     "chai": "^4.2.0",
     "eslint": "^7.5.0",
     "eslint-config-airbnb": "^18.2.0",
diff --git a/src/database.ts b/src/database.ts
@@ -1,4 +1,4 @@
-import { BaseDatabase, BaseResource } from 'admin-bro'
+import { BaseDatabase, BaseResource } from 'adminjs'
 import { Sequelize } from 'sequelize'
 
 import Resource from './resource'
diff --git a/src/property.ts b/src/property.ts
@@ -1,5 +1,5 @@
 /* eslint-disable no-underscore-dangle */
-import { BaseProperty, PropertyType } from 'admin-bro'
+import { BaseProperty, PropertyType } from 'adminjs'
 import { ModelAttributeColumnOptions } from 'sequelize/types'
 
 const TYPES_MAPPING = [
diff --git a/src/resource.spec.ts b/src/resource.spec.ts
@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
-import { ValidationError, Filter, BaseRecord } from 'admin-bro'
+import { ValidationError, Filter, BaseRecord } from 'adminjs'
 
 import chai, { expect } from 'chai'
 import sinonChai from 'sinon-chai'
diff --git a/src/resource.ts b/src/resource.ts
@@ -1,6 +1,6 @@
 /* eslint-disable no-param-reassign */
 import { unflatten } from 'flat'
-import { BaseResource, BaseRecord, BaseProperty, Filter } from 'admin-bro'
+import { BaseResource, BaseRecord, BaseProperty, Filter } from 'adminjs'
 import { Op } from 'sequelize'
 
 import { Model, ModelAttributeColumnOptions } from 'sequelize/types'
@@ -207,7 +207,7 @@ class Resource extends BaseResource {
    * What it does exactly:
    * - removes keys with empty strings for the `number`, `float` and 'reference' properties.
    *
-   * @param   {Object}  params  received from AdminBro form
+   * @param   {Object}  params  received from AdminJS form
    *
    * @return  {Object}          converted params
    */
diff --git a/src/utils/create-validation-error.ts b/src/utils/create-validation-error.ts
@@ -1,4 +1,4 @@
-import { ValidationError } from 'admin-bro'
+import { ValidationError } from 'adminjs'
 
 const createValidationError = (originalError) => {
   const errors = Object.keys(originalError.errors).reduce((memo, key) => {
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-AdminBro.UserComponents = {}`
	`1`	`+AdminJS.UserComponents = {}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { ResourceOptions } from 'admin-bro'`
	`1`	`+import { ResourceOptions } from 'adminjs'`
`2`	`2`
`3`	`3`	`const options: ResourceOptions = {`
`4`	`4`	`properties: {`