feat: Add export plugin button in dev mode in AdminCP

VitNode · Dec 9, 2024 · 6a05401 · 6a05401
1 parent 89ad465
commit 6a05401
Show file tree

Hide file tree

Showing 38 changed files with 340 additions and 104 deletions.
diff --git a/apps/frontend/src/plugins/admin/langs/en.json b/apps/frontend/src/plugins/admin/langs/en.json
@@ -299,9 +299,7 @@
           "desc": "We're detected changes in <bold>the plugin system</bold>. To apply these changes, you need to <bold>restart the server</bold>."
         },
         "dev": {
-          "overview": {
-            "title": "Overview"
-          },
+          "overview": "Overview",
           "nav": {
             "title": "Navigation in AdminCP",
             "lang_key": "Lang Key: <key></key>",
@@ -363,6 +361,18 @@
                 "desc": "If you delete this permission, all children will be deleted too."
               }
             }
+          },
+          "export": {
+            "title": "Export Plugin",
+            "desc": "Choose version to export.",
+            "type": {
+              "rebuild": "Rebuild current version - {version}",
+              "new_version": "Create new version"
+            },
+            "version": "Version",
+            "version_code": "Version Code",
+            "success": "Plugin has been exported.",
+            "submit": "Export"
           }
         },
         "create": {
@@ -411,20 +421,6 @@
           "submit": "Yes, delete plugin",
           "desc": "This action will delete <name></name> plugin created by <author></author> and all data associated with it.",
           "info": "After the process is complete, you need to restart the server to apply the changes."
-        },
-        "download": {
-          "title": "Download Plugin",
-          "type": {
-            "rebuild": "Rebuild current version - {version}",
-            "new_version": "Create new version"
-          },
-          "version": {
-            "label": "Version"
-          },
-          "version_code": {
-            "label": "Version Code"
-          },
-          "submit": "Download"
         }
       },
       "styles": {

diff --git a/packages/backend/src/core/admin/plugins/nav/nav.controller.ts b/packages/backend/src/core/admin/plugins/nav/nav.controller.ts
@@ -19,6 +19,7 @@ import { ShowNavPluginsAdminService } from './services/show.service';
   plugin_code: 'plugins',
   isAdmin: true,
   route: 'nav',
+  isDev: true,
 })
 export class NavPluginsAdminController {
   constructor(

diff --git a/packages/backend/src/core/admin/plugins/permissions-admin/permissions-admin.controller.ts b/packages/backend/src/core/admin/plugins/permissions-admin/permissions-admin.controller.ts
@@ -17,6 +17,7 @@ import { ShowPermissionsAdminPluginsAdminService } from './services/show.service
   plugin_code: 'plugins',
   isAdmin: true,
   route: 'permissions-admin',
+  isDev: true,
 })
 export class PermissionsAdminPluginsAdminController {
   constructor(

diff --git a/packages/backend/src/core/admin/plugins/plugins.controller.ts b/packages/backend/src/core/admin/plugins/plugins.controller.ts
@@ -1,5 +1,6 @@
 import type { Response } from 'express';
 
+import { OnlyForDevelopment } from '@/guards/dev.guard';
 import { Controllers } from '@/helpers/controller.decorator';
 import {
   Body,
@@ -10,6 +11,7 @@ import {
   Put,
   Query,
   Res,
+  UseGuards,
 } from '@nestjs/common';
 import { ApiCreatedResponse, ApiOkResponse } from '@nestjs/swagger';
 import { EditPluginsAdminBody } from 'vitnode-shared/admin/plugin.dto';
@@ -41,6 +43,7 @@ export class PluginsAdminController {
 
   @ApiCreatedResponse({ description: 'Plugin created', type: ShowPluginAdmin })
   @Post()
+  @UseGuards(OnlyForDevelopment)
   async createPlugin(
     @Body() body: CreatePluginsAdminBody,
   ): Promise<ShowPluginAdmin> {
@@ -49,6 +52,7 @@ export class PluginsAdminController {
 
   @ApiOkResponse({ description: 'Plugin deleted' })
   @Delete(':id')
+  @UseGuards(OnlyForDevelopment)
   async deletePlugin(@Param('id') id: string): Promise<void> {
     await this.deleteService.delete(+id);
   }
@@ -66,7 +70,8 @@ export class PluginsAdminController {
   }
 
   @ApiOkResponse({ description: 'Plugin exported' })
-  @Post('export/:code')
+  @Post(':code/export')
+  @UseGuards(OnlyForDevelopment)
   async exportPlugin(
     @Param('code') code: string,
     @Body() body: ExportPluginsAdminBody,

diff --git a/packages/backend/src/core/admin/plugins/services/export.service.ts b/packages/backend/src/core/admin/plugins/services/export.service.ts
@@ -55,6 +55,17 @@ export class ExportPluginsAdminService {
       });
     }
 
+    // Check if version_code is greater than the current version_code
+    if (
+      version_code &&
+      configJSON.version_code &&
+      version_code <= configJSON.version_code
+    ) {
+      return res.status(400).json({
+        message: 'Version code must be greater than the current version code',
+      });
+    }
+
     configJSON.allow_default = allow_default;
     configJSON.version = version ?? configJSON.version;
     configJSON.version_code = version_code ?? configJSON.version_code;
@@ -70,23 +81,21 @@ export class ExportPluginsAdminService {
           updated_at: new Date(),
         })
         .where(eq(core_plugins.code, code));
-
-      return;
+    } else {
+      await this.databaseService.db
+        .update(core_plugins)
+        .set({
+          version,
+          version_code,
+          allow_default,
+          updated_at: new Date(),
+        })
+        .where(eq(core_plugins.code, code));
     }
 
-    await this.databaseService.db
-      .update(core_plugins)
-      .set({
-        version,
-        version_code,
-        allow_default,
-        updated_at: new Date(),
-      })
-      .where(eq(core_plugins.code, code));
-
     // Prepare the export
     const tempFolderName = removeSpecialCharacters(
-      `${code}-${version}-${generateRandomString(5)}-${currentUnixDate()}`,
+      `${code}-${version ?? plugin.version}-${generateRandomString(5)}-${currentUnixDate()}`,
     );
     const tempPath = join(this.tempPath, tempFolderName);
     await mkdir(tempPath, { recursive: true });
@@ -135,10 +144,11 @@ export class ExportPluginsAdminService {
 
     // Copy shared files
     const sharedSource = ABSOLUTE_PATHS.plugin({ code }).shared;
-    if (!existsSync(sharedSource)) return;
-    const sharedPath = join(tempPath, 'shared');
-    await mkdir(sharedPath, { recursive: true });
-    await cp(sharedSource, sharedPath, { recursive: true });
+    if (existsSync(sharedSource)) {
+      const sharedPath = join(tempPath, 'shared');
+      await mkdir(sharedPath, { recursive: true });
+      await cp(sharedSource, sharedPath, { recursive: true });
+    }
 
     // Create tar
     const file = join(ABSOLUTE_PATHS.uploads.temp, `${tempFolderName}.tgz`);

diff --git a/packages/backend/src/helpers/controller.decorator.ts b/packages/backend/src/helpers/controller.decorator.ts
@@ -1,9 +1,11 @@
 import { AdminAuthGuard } from '@/guards/admin-auth.guard';
 import { AuthGuard } from '@/guards/auth.guard';
+import { OnlyForDevelopment } from '@/guards/dev.guard';
 import { applyDecorators, Controller, UseGuards } from '@nestjs/common';
 import { ApiSecurity, ApiTags } from '@nestjs/swagger';
 
 interface Args {
+  isDev?: boolean;
   plugin_code: string;
   plugin_name: string;
   route?: string;
@@ -30,9 +32,14 @@ export function Controllers({
   isAdmin,
   isProtect,
   route,
+  isDev,
 }: ArgsWithAdmin | ArgsWithout | ArgsWithProtect) {
   const decorators = [Controller(`${plugin_code}${route ? `/${route}` : ''}`)];
 
+  if (isDev) {
+    decorators.push(UseGuards(OnlyForDevelopment));
+  }
+
   if (isAdmin) {
     decorators.push(
       ApiTags(`Admin - ${plugin_name}`),

diff --git a/packages/backend/src/main.ts b/packages/backend/src/main.ts
@@ -22,6 +22,7 @@ export const nestjsMainApp = async (app: INestApplication, options?: Args) => {
   app.enableCors({
     ...options?.cors,
     credentials: true,
+    exposedHeaders: ['Content-Disposition'],
     origin: [
       process.env.NEXT_PUBLIC_FRONTEND_URL ?? 'http://localhost:3000',
       ...(options?.cors?.origin ?? []),

diff --git a/packages/frontend/src/api/fetcher-client.ts b/packages/frontend/src/api/fetcher-client.ts
@@ -40,6 +40,10 @@ export async function fetcherClient<
       : null,
   });
 
+  if (res.headers.get('Content-Disposition')) {
+    return { res, data: {} as TData };
+  }
+
   let data = {} as TData;
   try {
     data = await res.json();

diff --git a/packages/frontend/src/components/data-table/toolbar/filter/filter.tsx b/packages/frontend/src/components/data-table/toolbar/filter/filter.tsx
@@ -52,11 +52,11 @@ export function FilterToolbarDataTable({
       </PopoverTrigger>
 
       <PopoverContent align="start" className="w-56 p-0">
-        <FilterToolbarDataTableContext.Provider value={{ title, id }}>
+        <FilterToolbarDataTableContext value={{ title, id }}>
           <React.Suspense fallback={<Loader className="p-4" />}>
             {children}
           </React.Suspense>
-        </FilterToolbarDataTableContext.Provider>
+        </FilterToolbarDataTableContext>
       </PopoverContent>
     </Popover>
   );

diff --git a/packages/frontend/src/components/editor/editor.tsx b/packages/frontend/src/components/editor/editor.tsx
@@ -234,7 +234,7 @@ export const Editor = ({
   if (!editor) return null;
 
   return (
-    <EditorStateContext.Provider
+    <EditorStateContext
       value={{
         editor,
         value,
@@ -267,6 +267,6 @@ export const Editor = ({
           setSelectedLanguage={setSelectedLanguage}
         />
       </div>
-    </EditorStateContext.Provider>
+    </EditorStateContext>
   );
 };
diff --git a/packages/frontend/src/components/ui/alert-dialog.tsx b/packages/frontend/src/components/ui/alert-dialog.tsx
@@ -27,7 +27,7 @@ const AlertDialog = ({
   const [open, setOpen] = React.useState(false);
 
   return (
-    <AlertDialogContext.Provider
+    <AlertDialogContext
       value={{ open: openProp ?? open, setOpen: onOpenChange ?? setOpen }}
     >
       <AlertDialogPrimitive.Root
@@ -37,7 +37,7 @@ const AlertDialog = ({
       >
         {children}
       </AlertDialogPrimitive.Root>
-    </AlertDialogContext.Provider>
+    </AlertDialogContext>
   );
 };
 

diff --git a/packages/frontend/src/components/ui/carousel.tsx b/packages/frontend/src/components/ui/carousel.tsx
@@ -102,7 +102,7 @@ function Carousel({
   }, [api, onSelect]);
 
   return (
-    <CarouselContext.Provider
+    <CarouselContext
       value={{
         carouselRef,
         api: api,
@@ -123,7 +123,7 @@ function Carousel({
       >
         {children}
       </div>
-    </CarouselContext.Provider>
+    </CarouselContext>
   );
 }
 

diff --git a/packages/frontend/src/components/ui/chart.tsx b/packages/frontend/src/components/ui/chart.tsx
@@ -50,7 +50,7 @@ const ChartContainer = ({
   const chartId = `chart-${id ?? uniqueId.replace(/:/g, '')}`;
 
   return (
-    <ChartContext.Provider value={{ config }}>
+    <ChartContext value={{ config }}>
       <div
         className={cn(
           "[&_.recharts-cartesian-axis-tick_text]:fill-muted-foreground [&_.recharts-cartesian-grid_line[stroke='#ccc']]:stroke-border/50 [&_.recharts-curve.recharts-tooltip-cursor]:stroke-border [&_.recharts-polar-grid_[stroke='#ccc']]:stroke-border [&_.recharts-radial-bar-background-sector]:fill-muted [&_.recharts-rectangle.recharts-tooltip-cursor]:fill-muted [&_.recharts-reference-line_[stroke='#ccc']]:stroke-border flex aspect-video justify-center text-xs [&_.recharts-dot[stroke='#fff']]:stroke-transparent [&_.recharts-layer]:outline-none [&_.recharts-sector[stroke='#fff']]:stroke-transparent [&_.recharts-sector]:outline-none [&_.recharts-surface]:outline-none",
@@ -64,7 +64,7 @@ const ChartContainer = ({
           {children}
         </RechartsPrimitive.ResponsiveContainer>
       </div>
-    </ChartContext.Provider>
+    </ChartContext>
   );
 };
 

diff --git a/packages/frontend/src/components/ui/dialog.tsx b/packages/frontend/src/components/ui/dialog.tsx
@@ -31,7 +31,7 @@ const Dialog = ({
   const [isDirty, setIsDirty] = React.useState(false);
 
   return (
-    <DialogContext.Provider
+    <DialogContext
       value={{
         open: openProp ?? open,
         setOpen: val => {
@@ -50,7 +50,7 @@ const Dialog = ({
       >
         {children}
       </DialogPrimitive.Root>
-    </DialogContext.Provider>
+    </DialogContext>
   );
 };
 

diff --git a/packages/frontend/src/components/ui/form.tsx b/packages/frontend/src/components/ui/form.tsx
@@ -67,9 +67,9 @@ const FormField = <
   ...props
 }: ControllerProps<TFieldValues, TName>) => {
   return (
-    <FormFieldContext.Provider value={{ name: props.name }}>
+    <FormFieldContext value={{ name: props.name }}>
       <Controller {...props} />
-    </FormFieldContext.Provider>
+    </FormFieldContext>
   );
 };
 
@@ -111,9 +111,9 @@ const FormItem = ({
   const id = React.useId();
 
   return (
-    <FormItemContext.Provider value={{ id }}>
+    <FormItemContext value={{ id }}>
       <div className={cn('space-y-2', className)} {...props} />
-    </FormItemContext.Provider>
+    </FormItemContext>
   );
 };
 

diff --git a/packages/frontend/src/components/ui/sheet.tsx b/packages/frontend/src/components/ui/sheet.tsx
@@ -28,7 +28,7 @@ const Sheet = ({
   const [open, setOpen] = React.useState(false);
 
   return (
-    <SheetContext.Provider
+    <SheetContext
       value={{
         open: openProp ?? open,
         setOpen: onOpenChange ?? setOpen,
@@ -41,7 +41,7 @@ const Sheet = ({
       >
         {children}
       </SheetPrimitive.Root>
-    </SheetContext.Provider>
+    </SheetContext>
   );
 };
 

diff --git a/packages/frontend/src/components/ui/sidebar.tsx b/packages/frontend/src/components/ui/sidebar.tsx
@@ -129,7 +129,7 @@ const SidebarProvider = ({
   );
 
   return (
-    <SidebarContext.Provider value={contextValue}>
+    <SidebarContext value={contextValue}>
       <TooltipProvider delayDuration={0}>
         <div
           className={cn(
@@ -148,7 +148,7 @@ const SidebarProvider = ({
           {children}
         </div>
       </TooltipProvider>
-    </SidebarContext.Provider>
+    </SidebarContext>
   );
 };
 

diff --git a/packages/frontend/src/components/ui/toggle-group.tsx b/packages/frontend/src/components/ui/toggle-group.tsx
@@ -26,9 +26,9 @@ const ToggleGroup = ({
     className={cn('flex items-center justify-center gap-1', className)}
     {...props}
   >
-    <ToggleGroupContext.Provider value={{ variant, size }}>
+    <ToggleGroupContext value={{ variant, size }}>
       {children}
-    </ToggleGroupContext.Provider>
+    </ToggleGroupContext>
   </ToggleGroupPrimitive.Root>
 );