Merge pull request #3 from SoftwareBrothers/feat/rebrand

chore: rebrand AdminBro to AdminJS

Author: dziraf

.github/workflows/push.yml

@@ -10,7 +10,7 @@ jobs:
       - name: Setup
         uses: actions/setup-node@v1
         with:
-          node-version: '10.x'
+          node-version: '14'
       - uses: actions/cache@v1
         id: yarn-cache
         with:

.npmrc

@@ -1 +1 @@
-registry=https://npm.pkg.github.com/SoftwareBrothers
+access=public

.releaserc

@@ -19,7 +19,7 @@
       "semantic-release-slack-bot",
       {
         "notifyOnSuccess": true,
-        "notifyOnFail": true
+        "notifyOnFail": false
       }
     ]
   ]

LICENSE

@@ -1,4 +1,4 @@
-Copyright 2018 SoftwareBrothers.co
+Copyright 2021 SoftwareBrothers.co
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -1,21 +1,21 @@
-# Logger Feature for AdminBro
+# Logger Feature for AdminJS
 
-This is an official [AdminBro](https://github.com/SoftwareBrothers/admin-bro) feature which logs changes to resources.
+This is an official [AdminJS](https://github.com/SoftwareBrothers/adminjs) feature which logs changes to resources.
 
-## 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
 
-Or visit [AdminBro](https://github.com/SoftwareBrothers/admin-bro) github page.
+Or visit [AdminJS](https://github.com/SoftwareBrothers/adminjs) github page.
 
 ## Usage
 
 
 ## 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 © 2021 SoftwareBrothers.co. It is free software, and may be redistributed under the terms specified in the [LICENSE](LICENSE.md) file.
 
 ## About SoftwareBrothers.co
 

package.json

@@ -1,10 +1,10 @@
 {
-  "name": "@softwarebrothers/admin-bro-logger",
+  "name": "@adminjs/logger",
   "version": "1.0.1",
   "main": "lib/index.js",
   "types": "types/index.d.ts",
   "private": false,
-  "repository": "[email protected]:SoftwareBrothers/admin-bro-logger.git",
+  "repository": "[email protected]:SoftwareBrothers/adminjs-logger.git",
   "license": "MIT",
   "scripts": {
     "release": "semantic-release",
@@ -20,16 +20,18 @@
     }
   },
   "peerDependencies": {
-    "admin-bro": ">=3.3.0-beta.13"
+    "adminjs": "^5.3.1",
+    "@adminjs/design-system": "^2.0.2"
   },
   "devDependencies": {
+    "@adminjs/design-system": "^2.0.2",
     "@commitlint/cli": "^8.3.5",
     "@commitlint/config-conventional": "^8.3.4",
     "@semantic-release/git": "^9.0.0",
     "@types/jest": "^26.0.14",
     "@typescript-eslint/eslint-plugin": "^3.7.0",
     "@typescript-eslint/parser": "^3.7.0",
-    "admin-bro": "3.3.0-beta.13",
+    "adminjs": "^5.3.1",
     "eslint": "^7.5.0",
     "eslint-config-prettier": "^6.10.1",
     "eslint-plugin-import": "^2.22.0",

src/components/RecordDifference.tsx

@@ -1,5 +1,5 @@
 import React, { FC } from 'react';
-import { BasePropertyProps, flat } from 'admin-bro';
+import { BasePropertyProps, flat } from 'adminjs';
 import {
   FormGroup,
   Label,
@@ -8,7 +8,7 @@ import {
   TableBody,
   TableHead,
   TableRow,
-} from '@admin-bro/design-system';
+} from '@adminjs/design-system';
 import styled from 'styled-components';
 
 const Cell = styled(TableCell)`
@@ -31,6 +31,7 @@ const Table = styled(AdminTable)`
 
 const RecordDifference: FC<BasePropertyProps> = ({ record, property }) => {
   const differences = JSON.parse(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     (flat.unflatten(record?.params ?? {}) as any)?.[property.name] ?? {}
   );
   if (!differences) {

src/components/RecordLink.tsx

@@ -1,6 +1,6 @@
 import React, { FC } from 'react';
-import { BasePropertyProps, ViewHelpers } from 'admin-bro';
-import { FormGroup, Link } from '@admin-bro/design-system';
+import { BasePropertyProps, ViewHelpers } from 'adminjs';
+import { FormGroup, Link } from '@adminjs/design-system';
 
 const viewHelpers = new ViewHelpers();
 const RecordLink: FC<BasePropertyProps> = ({ record }) => {

src/components/bundle.ts

@@ -1,11 +1,11 @@
-import AdminBro from 'admin-bro';
+import AdminJS from 'adminjs';
 
 export const bundleComponents = (): {
   RECORD_DIFFERENCE: string;
   RECORD_LINK: string;
 } => {
   return {
-    RECORD_DIFFERENCE: AdminBro.bundle('../../src/components/RecordDifference'),
-    RECORD_LINK: AdminBro.bundle('../../src/components/RecordLink'),
+    RECORD_DIFFERENCE: AdminJS.bundle('../../src/components/RecordDifference'),
+    RECORD_LINK: AdminJS.bundle('../../src/components/RecordLink'),
   };
 };

src/index.ts

@@ -1,5 +1,5 @@
 /**
- * @module @admin-bro/logger
+ * @module @adminjs/logger
  * @subcategory Features
  * @section modules
  */

src/log.action.ts

@@ -1,4 +1,4 @@
-import { ActionResponse, After, Before, flat } from 'admin-bro';
+import { ActionResponse, After, Before, flat } from 'adminjs';
 import { merge } from 'lodash';
 import { difference } from './utils/difference';
 
@@ -25,55 +25,55 @@ const getRecordTitle = modifiedRecord => {
   );
 };
 
-export const createLogAction = ({
-  onlyForPostMethod = false,
-}: CreateLogActionParams = {}): After<ActionResponse> => async (
-  response,
-  request,
-  context
-) => {
-  const { currentAdmin, _admin } = context;
-  const { params, method } = request;
-  const Log = _admin.findResource('Log');
-  const ModifiedResource = _admin.findResource(params.resourceId);
+export const createLogAction =
+  ({
+    onlyForPostMethod = false,
+  }: CreateLogActionParams = {}): After<ActionResponse> =>
+  async (response, request, context) => {
+    const { currentAdmin, _admin } = context;
+    const { params, method } = request;
+    const Log = _admin.findResource('Log');
+    const ModifiedResource = _admin.findResource(params.resourceId);
 
-  if (!params.recordId || (onlyForPostMethod && !(method === 'post'))) {
-    return response;
-  }
-
-  const currentUser = currentAdmin?.id ?? currentAdmin?._id ?? currentAdmin;
-
-  try {
-    const modifiedRecord = merge(
-      JSON.parse(JSON.stringify(context.record)),
-      await ModifiedResource.findOne(params.recordId)
-    );
-    if (!modifiedRecord) {
+    if (!params.recordId || (onlyForPostMethod && !(method === 'post'))) {
       return response;
     }
 
-    const newParamsToCompare =
-      params.action === 'delete'
-        ? {}
-        : flat.flatten(JSON.parse(JSON.stringify(modifiedRecord.params)));
-    await Log.create({
-      recordTitle: getRecordTitle(modifiedRecord),
-      resource: params.resourceId,
-      action: params.action,
-      recordId:
-        params.recordId ?? typeof modifiedRecord.id === 'string'
-          ? modifiedRecord.id
-          : modifiedRecord.id?.(),
-      user: currentUser,
-      difference: JSON.stringify(
-        difference(
-          newParamsToCompare,
-          flat.flatten(JSON.parse(JSON.stringify(context.initialRecord.params)))
-        )
-      ),
-    });
-  } catch (e) {
-    console.error(e);
-  }
-  return response;
-};
+    const currentUser = currentAdmin?.id ?? currentAdmin?._id ?? currentAdmin;
+
+    try {
+      const modifiedRecord = merge(
+        JSON.parse(JSON.stringify(context.record)),
+        await ModifiedResource.findOne(params.recordId)
+      );
+      if (!modifiedRecord) {
+        return response;
+      }
+
+      const newParamsToCompare =
+        params.action === 'delete'
+          ? {}
+          : flat.flatten(JSON.parse(JSON.stringify(modifiedRecord.params)));
+      await Log.create({
+        recordTitle: getRecordTitle(modifiedRecord),
+        resource: params.resourceId,
+        action: params.action,
+        recordId:
+          params.recordId ?? typeof modifiedRecord.id === 'string'
+            ? modifiedRecord.id
+            : modifiedRecord.id?.(),
+        user: currentUser,
+        difference: JSON.stringify(
+          difference(
+            newParamsToCompare,
+            flat.flatten(
+              JSON.parse(JSON.stringify(context.initialRecord.params))
+            )
+          )
+        ),
+      });
+    } catch (e) {
+      console.error(e);
+    }
+    return response;
+  };

src/logger.feature.ts

@@ -1,4 +1,4 @@
-import { buildFeature, FeatureType } from 'admin-bro';
+import { buildFeature, FeatureType } from 'adminjs';
 import { createLogAction, rememberInitialRecord } from './log.action';
 
 const loggerFeature = (): FeatureType => {

src/logger.resource.ts

@@ -1,4 +1,4 @@
-import { ResourceWithOptions } from 'admin-bro';
+import { ResourceWithOptions } from 'adminjs';
 import { bundleComponents } from './components/bundle';
 
 const { RECORD_DIFFERENCE, RECORD_LINK } = bundleComponents();

src/utils/with-logger.ts

@@ -1,4 +1,4 @@
-import { Action, ActionResponse, After, Before } from 'admin-bro';
+import { Action, ActionResponse, After, Before } from 'adminjs';
 import { createLogAction, rememberInitialRecord } from '../log.action';
 
 export const withLogger = (

tsconfig.json

@@ -15,6 +15,7 @@
     "baseUrl": "./",
     "outDir": "lib",
     "declarationDir": "types",
+    "skipLibCheck": true,
     "allowSyntheticDefaultImports": true
   },
   "exclude": ["test", "lib", "types"]