feat(backend): Add schema types in config.json plugin

VitNode · Jan 1, 2025 · 463d5a8 · 463d5a8
1 parent d3c9a87
commit 463d5a8
Show file tree

Hide file tree

Showing 18 changed files with 141 additions and 105 deletions.
diff --git a/...backend/src/plugins/welcome/metadata.json → apps/backend/src/plugins/welcome/config.json b/...backend/src/plugins/welcome/metadata.json → apps/backend/src/plugins/welcome/config.json
@@ -1,4 +1,5 @@
 {
+  "$schema": "https://api.vitnode.com/public/vitnode/plugin.schema.json",
   "name": "Welcome",
   "description": "Basic plugin with default page.",
   "version": "1.0.0",
@@ -25,7 +26,7 @@
   "permissions_admin": [
     {
       "id": "test",
-      "permissions": ["test123"]
+      "permissions": []
     }
   ]
 }
diff --git a/packages/backend/scripts/update-plugins.ts b/packages/backend/scripts/update-plugins.ts
@@ -33,13 +33,13 @@ export const updatePlugins = async ({
     await Promise.all(
       plugins.map(async (code, index) => {
         const pluginPath = join(pluginsPath, code);
-        const configPath = join(pluginPath, 'metadata.json');
+        const configPath = join(pluginPath, 'config.json');
         if (!existsSync(configPath)) {
           return;
         }
 
         const config = JSON.parse(
-          await readFile(join(pluginPath, 'metadata.json'), 'utf8'),
+          await readFile(join(pluginPath, 'config.json'), 'utf8'),
         );
 
         if (config.allow_default) {

diff --git a/packages/backend/src/app.module.ts b/packages/backend/src/app.module.ts
@@ -39,7 +39,7 @@ export const ABSOLUTE_PATHS = {
   plugin: ({ code }: { code: string }) => ({
     root: join(internalPaths.plugins, code),
     admin: join(internalPaths.plugins, code, 'admin'),
-    metadata: join(internalPaths.plugins, code, 'metadata.json'),
+    config: join(internalPaths.plugins, code, 'config.json'),
     database: join(internalPaths.plugins, code, 'admin', 'database'),
     shared: join(internalPaths.shared, code),
     frontend: {

diff --git a/packages/backend/src/core/admin/auth/services/nav/nav.service.ts b/packages/backend/src/core/admin/auth/services/nav/nav.service.ts
@@ -19,7 +19,7 @@ export class NavAuthAdminService {
 
   async nav({ user }: { user: User }): Promise<ShowAuthAdminObj['nav']> {
     const permissions: {
-      groups: { id: string; permissions: string[] }[];
+      groups: { id: string; permissions?: string[] }[];
       plugin_code: string;
     }[] = await this.userHelper.getUserAdminPermission({
       user,
@@ -35,7 +35,7 @@ export class NavAuthAdminService {
 
     const navFromPlugins = await Promise.all(
       adminNavPlugins.map(async ({ code }) => {
-        const pathConfig = ABSOLUTE_PATHS.plugin({ code }).metadata;
+        const pathConfig = ABSOLUTE_PATHS.plugin({ code }).config;
         if (!existsSync(pathConfig)) {
           return {
             code,
@@ -54,9 +54,20 @@ export class NavAuthAdminService {
       }),
     );
 
-    const nav = [...coreNav, ...navFromPlugins].filter(
-      plugin => plugin.nav.length > 0,
-    );
+    const nav: ShowAuthAdminObj['nav'] = [...coreNav, ...navFromPlugins]
+      .filter(plugin => (plugin.nav ?? []).length > 0)
+      .map(plugin => ({
+        ...plugin,
+        nav: (plugin.nav ?? []).map(nav => ({
+          ...nav,
+          keywords: nav.keywords ?? [],
+          children: (nav.children ?? []).map(child => ({
+            ...child,
+            keywords: child.keywords ?? [],
+          })),
+        })),
+      }));
+
     if (permissions.length === 0) return nav;
 
     // Create a map for quick lookup of permissions by plugin code
@@ -70,60 +81,62 @@ export class NavAuthAdminService {
     );
 
     // Map over the filtered plugins to process their nav items
-    const filterGroups = pluginsInPermissions.map(plugin => {
-      const pluginPermission = permissionMap.get(plugin.code);
-      if (!pluginPermission) return plugin;
-
-      // Create a map of group IDs to group objects with a Set of permissions
-      const groupMap = new Map();
-      pluginPermission.groups.forEach(group => {
-        groupMap.set(group.id, {
-          ...group,
-          permissionSet: new Set(group.permissions),
+    const filterGroups: ShowAuthAdminObj['nav'] = pluginsInPermissions.map(
+      plugin => {
+        const pluginPermission = permissionMap.get(plugin.code);
+        if (!pluginPermission) return plugin;
+
+        // Create a map of group IDs to group objects with a Set of permissions
+        const groupMap = new Map();
+        pluginPermission.groups.forEach(group => {
+          groupMap.set(group.id, {
+            ...group,
+            permissionSet: new Set(group.permissions),
+          });
         });
-      });
 
-      // Filter the nav items based on the permissions
-      const filteredNav = plugin.nav.filter(navItem => {
-        return (
-          groupMap.has(navItem.code) ||
-          groupMap.has(`can_manage_${navItem.code}`) ||
-          navItem.code === 'dashboard'
-        );
-      });
+        // Filter the nav items based on the permissions
+        const filteredNav = (plugin.nav ?? []).filter(navItem => {
+          return (
+            groupMap.has(navItem.code) ||
+            groupMap.has(`can_manage_${navItem.code}`) ||
+            navItem.code === 'dashboard'
+          );
+        });
 
-      // Map over filteredNav to process each navItem
-      const processedNav = filteredNav.map(navItem => {
-        const group =
-          groupMap.get(navItem.code) ||
-          groupMap.get(`can_manage_${navItem.code}`);
+        // Map over filteredNav to process each navItem
+        const processedNav = filteredNav.map(navItem => {
+          const group =
+            groupMap.get(navItem.code) ||
+            groupMap.get(`can_manage_${navItem.code}`);
 
-        if (!group) {
-          return { ...navItem, permissions: [] };
-        }
+          if (!group) {
+            return { ...navItem, permissions: [] };
+          }
 
-        // If group.permissions is empty, return navItem as is
-        if (group.permissions.length === 0) {
-          return navItem;
-        }
+          // If group.permissions is empty, return navItem as is
+          if (group.permissions.length === 0) {
+            return navItem;
+          }
 
-        // Filter navItem's children based on group.permissions
-        const filteredChildren = navItem.children?.filter(child =>
-          group.permissionSet.has(`can_manage_${group.id}_${child.code}`),
-        );
+          // Filter navItem's children based on group.permissions
+          const filteredChildren = navItem.children?.filter(child =>
+            group.permissionSet.has(`can_manage_${group.id}_${child.code}`),
+          );
+
+          return {
+            ...navItem,
+            children: filteredChildren,
+          };
+        });
 
         return {
-          ...navItem,
-          children: filteredChildren,
+          ...plugin,
+          nav: processedNav,
         };
-      });
-
-      return {
-        ...plugin,
-        nav: processedNav,
-      };
-    });
+      },
+    );
 
-    return filterGroups.filter(plugin => plugin.nav.length > 0);
+    return filterGroups.filter(plugin => (plugin.nav ?? []).length > 0);
   }
 }
diff --git a/packages/backend/src/core/admin/auth/services/nav/search.service.ts b/packages/backend/src/core/admin/auth/services/nav/search.service.ts
@@ -43,7 +43,7 @@ export class SearchAuthAdminService {
           return [nav, ...mappedChildren];
         });
       })
-      .filter(nav => nav.keywords.length);
+      .filter(nav => (nav.keywords ?? []).length);
 
     if (search.length === 0) {
       return {
@@ -54,7 +54,7 @@ export class SearchAuthAdminService {
     return {
       nav: nav.filter(
         nav =>
-          nav.keywords.some(item =>
+          (nav.keywords ?? []).some(item =>
             search.some(search => item.toLowerCase().includes(search)),
           ) || search.some(search => nav.code.toLowerCase().includes(search)),
       ),

diff --git a/packages/backend/src/core/admin/members/staff/admin/services/show.service.ts b/packages/backend/src/core/admin/members/staff/admin/services/show.service.ts
@@ -34,7 +34,7 @@ export class ShowAdminStaffMembersAdminService {
       plugin => {
         const pathConfig = ABSOLUTE_PATHS.plugin({
           code: plugin.code,
-        }).metadata;
+        }).config;
         if (!existsSync(pathConfig)) {
           return {
             plugin_code: plugin.code,
@@ -50,7 +50,10 @@ export class ShowAdminStaffMembersAdminService {
         return {
           plugin_code: plugin.code,
           plugin: plugin.name,
-          groups: config.permissions_admin ?? [],
+          groups: (config.permissions_admin ?? []).map(group => ({
+            ...group,
+            permissions: group.permissions ?? [],
+          })),
         };
       },
     );

diff --git a/packages/backend/src/core/admin/plugins/nav/helpers.service.ts b/packages/backend/src/core/admin/plugins/nav/helpers.service.ts
@@ -1,8 +1,6 @@
 import { Injectable } from '@nestjs/common';
-import {
-  ConfigPlugin,
-  NavPluginInfoJSONType,
-} from 'vitnode-shared/admin/plugin.dto';
+import { ItemNavAuthAdminObj } from 'vitnode-shared/admin/auth.dto';
+import { ConfigPlugin } from 'vitnode-shared/admin/plugin.dto';
 
 @Injectable()
 export class HelpersAdminNavPluginsService {
@@ -12,10 +10,22 @@ export class HelpersAdminNavPluginsService {
   }: {
     code: string;
     items: ConfigPlugin['nav'];
-  }): NavPluginInfoJSONType | null {
-    for (const item of items) {
+  }):
+    | (ItemNavAuthAdminObj & {
+        children?: ItemNavAuthAdminObj[];
+        parent_code?: string;
+      })
+    | null {
+    for (const item of items ?? []) {
       if (item.code === code) {
-        return item;
+        return {
+          ...item,
+          keywords: item.keywords ?? [],
+          children: (item.children ?? []).map(child => ({
+            ...child,
+            keywords: child.keywords ?? [],
+          })),
+        };
       }
 
       if (item.children) {

diff --git a/packages/backend/src/core/admin/plugins/nav/services/change_position.service.ts b/packages/backend/src/core/admin/plugins/nav/services/change_position.service.ts
@@ -16,7 +16,7 @@ export class ChangePositionNavPluginsAdminService extends HelpersAdminNavPlugins
     code: string;
     items: ConfigPlugin['nav'];
   }): ConfigPlugin['nav'] {
-    return items.filter(item => {
+    return (items ?? []).filter(item => {
       if (item.code === code) {
         return false;
       }
@@ -43,7 +43,7 @@ export class ChangePositionNavPluginsAdminService extends HelpersAdminNavPlugins
   }): Promise<void> {
     const pathConfig = ABSOLUTE_PATHS.plugin({
       code: plugin_code,
-    }).metadata;
+    }).config;
     if (!existsSync(pathConfig)) {
       throw new NotFoundException();
     }
@@ -74,7 +74,7 @@ export class ChangePositionNavPluginsAdminService extends HelpersAdminNavPlugins
       // Move children to root if itemToMove has children
       if (itemToMove.children && itemToMove.children.length > 0) {
         config.nav = [
-          ...config.nav,
+          ...(config.nav ?? []),
           ...itemToMove.children.map(child => ({
             ...child,
             children: [],
@@ -87,6 +87,7 @@ export class ChangePositionNavPluginsAdminService extends HelpersAdminNavPlugins
       parentItem.children.splice(index_to_move, 0, itemToMove);
     } else {
       // If parent_code is not provided, add the item to the root of the nav array
+      config.nav = config.nav ?? [];
       config.nav.splice(index_to_move, 0, itemToMove);
     }
 

diff --git a/packages/backend/src/core/admin/plugins/nav/services/create.service.ts b/packages/backend/src/core/admin/plugins/nav/services/create.service.ts
@@ -24,7 +24,7 @@ export class CreateNavPluginsAdminService extends HelpersAdminNavPluginsService
   }): Promise<ParentNavAuthAdminObj> {
     const pathConfig = ABSOLUTE_PATHS.plugin({
       code: plugin_code,
-    }).metadata;
+    }).config;
     if (!existsSync(pathConfig)) {
       throw new NotFoundException();
     }
@@ -42,7 +42,7 @@ export class CreateNavPluginsAdminService extends HelpersAdminNavPluginsService
 
     // Update config
     if (parent_code) {
-      const parent = config.nav.find(nav => nav.code === parent_code);
+      const parent = (config.nav ?? []).find(nav => nav.code === parent_code);
 
       if (!parent) {
         throw new NotFoundException('PARENT_NOT_FOUND');
@@ -55,6 +55,7 @@ export class CreateNavPluginsAdminService extends HelpersAdminNavPluginsService
         keywords,
       });
     } else {
+      config.nav = config.nav ?? [];
       config.nav.push({
         code: currentCode,
         icon,

diff --git a/packages/backend/src/core/admin/plugins/nav/services/delete.service.ts b/packages/backend/src/core/admin/plugins/nav/services/delete.service.ts
@@ -18,15 +18,15 @@ export class DeleteNavPluginsAdminService {
   }): Promise<void> {
     const pathConfig = ABSOLUTE_PATHS.plugin({
       code: plugin_code,
-    }).metadata;
+    }).config;
     if (!existsSync(pathConfig)) {
       throw new NotFoundException();
     }
     const config: ConfigPlugin = JSON.parse(await readFile(pathConfig, 'utf8'));
 
     // Update config
     if (parent_code) {
-      const parent = config.nav.find(nav => nav.code === parent_code);
+      const parent = (config.nav ?? []).find(nav => nav.code === parent_code);
 
       if (!parent) {
         throw new NotFoundException('PARENT_NOT_FOUND');
@@ -36,12 +36,12 @@ export class DeleteNavPluginsAdminService {
         child => child.code !== code,
       );
     } else {
-      const codeExists = config.nav.find(nav => nav.code === code);
+      const codeExists = (config.nav ?? []).find(nav => nav.code === code);
       if (!codeExists) {
         throw new NotFoundException();
       }
 
-      config.nav = config.nav.filter(nav => nav.code !== code);
+      config.nav = (config.nav ?? []).filter(nav => nav.code !== code);
     }
 
     await writeFile(pathConfig, JSON.stringify(config, null, 2));

diff --git a/packages/backend/src/core/admin/plugins/nav/services/edit.service.ts b/packages/backend/src/core/admin/plugins/nav/services/edit.service.ts
@@ -24,20 +24,22 @@ export class EditNavPluginsAdminService {
   }): Promise<ParentNavAuthAdminObj> {
     const pathConfig = ABSOLUTE_PATHS.plugin({
       code: plugin_code,
-    }).metadata;
+    }).config;
     if (!existsSync(pathConfig)) {
       throw new NotFoundException();
     }
     const config: ConfigPlugin = JSON.parse(await readFile(pathConfig, 'utf8'));
 
     const currentCode = removeSpecialCharacters(code);
-    const existsNavCode = config.nav.find(nav => nav.code === currentCode);
+    const existsNavCode = (config.nav ?? []).find(
+      nav => nav.code === currentCode,
+    );
     if (existsNavCode && code !== existsNavCode.code) {
       throw new ConflictException('CODE_ALREADY_EXISTS');
     }
 
     if (parent_code) {
-      const parent = config.nav.find(nav => nav.code === parent_code);
+      const parent = (config.nav ?? []).find(nav => nav.code === parent_code);
 
       if (!parent) {
         throw new NotFoundException('PARENT_NOT_FOUND');
@@ -53,7 +55,10 @@ export class EditNavPluginsAdminService {
         keywords,
       };
     } else {
-      const navIndex = config.nav.findIndex(nav => nav.code === previous_code);
+      const navIndex = (config.nav ?? []).findIndex(
+        nav => nav.code === previous_code,
+      );
+      config.nav = config.nav ?? [];
       config.nav[navIndex] = {
         code: currentCode,
         icon,