feat: add BasePlugin

src/index.ts

@@ -5,6 +5,7 @@ export * from './adapters'
 export * from './adminjs-options.interface'
 export * from './controllers'
 export * from './decorators'
+export * from './plugins'
 export * from './services'
 export * from './utils'
 

src/plugins/base-plugin.ts

@@ -0,0 +1,20 @@
+/* eslint-disable class-methods-use-this */
+import { NotImplementedError } from '@adminjs/common/errors'
+import AdminJS from '../adminjs'
+
+class BasePlugin<T = Record<string, unknown>> {
+  protected admin: AdminJS
+
+  protected options: T
+
+  constructor(admin: AdminJS, options: T) {
+    this.admin = admin
+    this.options = options
+  }
+
+  public buildRoutes() {
+    throw new NotImplementedError('BasePlugin#buildRoutes')
+  }
+}
+
+export default BasePlugin

src/plugins/index.ts

@@ -0,0 +1 @@
+export { default as BasePlugin } from './base-plugin'

src/utils/router/router.ts

@@ -1,27 +1,27 @@
 import ApiController from '../../controllers/api-controller'
 
+export type AdminRoute = {
+  method: string;
+  path: string;
+  Controller: any;
+  action: string;
+  contentType?: string;
+}
+
 /**
  * Type representing the AdminJS.Router
  * @memberof Router
  * @alias RouterType
  */
 export type RouterType = {
-  assets: Array<any>;
-  routes: Array<{
-    method: string;
-    path: string;
-    Controller: any;
-    action: string;
-    contentType?: string;
-  }>;
+  routes: Array<AdminRoute>;
 }
 
 /**
  * @load ./router.doc.md
  * @namespace
  */
 export const Router: RouterType = {
-  assets: [], // todo: remove assets
   routes: [{
     method: 'GET',
     path: '/api/resources/{resourceId}/search/{query}',