@next-vibe/checker 1.0.11 → 1.0.12

package/src/app/api/[locale]/system/help/repository.ts

@@ -0,0 +1,212 @@
+/**
+ * Help Repository
+ * Provides help information about CLI commands
+ * Uses shared help service for unified command discovery
+ */
+
+/* eslint-disable i18next/no-literal-string */
+import type { ResponseType } from "next-vibe/shared/types/response.schema";
+import {
+  ErrorResponseTypes,
+  fail,
+  success,
+} from "next-vibe/shared/types/response.schema";
+import { parseError } from "next-vibe/shared/utils";
+
+import type { JwtPayloadType } from "@/app/api/[locale]/user/auth/types";
+
+import { definitionsRegistry } from "../../system/unified-interface/shared/endpoints/definitions/registry";
+import type { EndpointLogger } from "../../system/unified-interface/shared/logger/endpoint";
+import type { Platform } from "../../system/unified-interface/shared/types/platform";
+import { endpointToToolName } from "../../system/unified-interface/shared/utils/path";
+import type { CreateApiEndpointAny } from "../unified-interface/shared/types/endpoint";
+import type { HelpRequestOutput, HelpResponseOutput } from "./definition";
+
+/**
+ * Help Repository
+ */
+class HelpRepository {
+  /**
+   * Execute the help command
+   */
+  execute(
+    data: HelpRequestOutput,
+    user: JwtPayloadType,
+    logger: EndpointLogger,
+    platform: Platform,
+  ): ResponseType<HelpResponseOutput> {
+    logger.info("Generating help information", {
+      command: data.command || "all",
+    });
+
+    try {
+      // Discover commands (filtered by user permissions from JWT)
+      const commands = definitionsRegistry.getEndpointsForUser(
+        platform,
+        user,
+        logger,
+      );
+
+      if (data.command) {
+        // Show help for specific command
+        const command = commands.find((cmd) => {
+          const toolName = endpointToToolName(cmd);
+          return (
+            toolName === data.command ||
+            cmd.aliases?.includes(data.command || "")
+          );
+        });
+
+        if (!command) {
+          return fail({
+            message: "app.api.system.help.post.errors.notFound.title",
+            errorType: ErrorResponseTypes.NOT_FOUND,
+            messageParams: { command: data.command },
+          });
+        }
+
+        const response = this.formatCommandHelp(command);
+        logger.info("Command help generated successfully");
+        return success(response);
+      }
+
+      // Show general help with usage information
+      const response = this.formatGeneralHelp();
+      logger.info("General help generated successfully");
+      return success(response);
+    } catch (error) {
+      const parsedError = parseError(error);
+      logger.error("Failed to generate help information", parsedError);
+      return fail({
+        message: "app.api.system.help.post.errors.server.title",
+        errorType: ErrorResponseTypes.INTERNAL_ERROR,
+        messageParams: { error: parsedError.message },
+      });
+    }
+  }
+
+  /**
+   * Format help for a specific command
+   */
+  private formatCommandHelp(command: CreateApiEndpointAny): HelpResponseOutput {
+    const toolName = endpointToToolName(command);
+    return {
+      header: {
+        title: `${toolName} - ${command.description || "No description available"}`,
+        description: command.description,
+      },
+      usage: {
+        patterns: [`vibe ${toolName} [options]`],
+      },
+      commonCommands: {
+        items: [], // Empty for specific command help
+      },
+      details: {
+        category: command.category,
+        path: command.path.join("/"),
+        method: command.method,
+        aliases:
+          command.aliases && command.aliases.length > 0
+            ? command.aliases.join(", ")
+            : undefined,
+      },
+      options: {
+        items: [
+          {
+            flag: "-d, --data <json>",
+            description: "Pass JSON data to command",
+          },
+          {
+            flag: "-o, --output <format>",
+            description: "Output format (pretty|json)",
+          },
+          {
+            flag: "-v, --verbose",
+            description: "Enable verbose output",
+          },
+          {
+            flag: "--help",
+            description: "Show this help",
+          },
+        ],
+      },
+      examples: {
+        items: [
+          {
+            command: `vibe ${toolName}`,
+            description: "Run command with default options",
+          },
+          {
+            command: `vibe ${toolName} --help`,
+            description: "Show command help",
+          },
+        ],
+      },
+    };
+  }
+
+  /**
+   * Format general help with usage information
+   */
+  private formatGeneralHelp(): HelpResponseOutput {
+    return {
+      header: {
+        title: "Vibe CLI - Next-generation API execution tool",
+        description:
+          "Command-line interface for Next-Vibe API with real-time execution",
+      },
+      usage: {
+        patterns: ["vibe <command> [options]", "vibe <command> --help"],
+      },
+      commonCommands: {
+        items: [
+          { command: "list", description: "List all available commands" },
+          {
+            command: "help <cmd>",
+            description: "Show help for a specific command",
+          },
+          { command: "check", description: "Run code quality checks" },
+          { command: "db:migrate", description: "Run database migrations" },
+          { command: "test", description: "Run test suite" },
+        ],
+      },
+      details: {
+        // Empty for general help
+      },
+      options: {
+        items: [
+          {
+            flag: "-d, --data <json>",
+            description: "Pass JSON data to command",
+          },
+          {
+            flag: "-o, --output <format>",
+            description: "Output format (pretty|json)",
+          },
+          {
+            flag: "-v, --verbose",
+            description: "Enable verbose output",
+          },
+          {
+            flag: "-l, --locale <locale>",
+            description: "Set locale (en-GLOBAL|de-DE|pl-PL)",
+          },
+          {
+            flag: "--help",
+            description: "Show this help",
+          },
+        ],
+      },
+      examples: {
+        items: [
+          { command: "vibe list", description: "List all commands" },
+          { command: "vibe check src/", description: "Run checks" },
+          { command: "vibe db:migrate", description: "Run migrations" },
+          { command: "vibe help check", description: "Get command help" },
+        ],
+      },
+    };
+  }
+}
+
+export const helpRepository = new HelpRepository();

package/src/app/api/[locale]/system/help/route.ts

@@ -0,0 +1,16 @@
+import "server-only";
+
+import { endpointsHandler } from "@/app/api/[locale]/system/unified-interface/shared/endpoints/route/multi";
+import { Methods } from "@/app/api/[locale]/system/unified-interface/shared/types/enums";
+
+import helpEndpoints from "./definition";
+import { helpRepository } from "./repository";
+
+export const { POST, tools } = endpointsHandler({
+  endpoint: helpEndpoints,
+  [Methods.POST]: {
+    handler: ({ data, user, logger, platform }) => {
+      return helpRepository.execute(data, user, logger, platform);
+    },
+  },
+});

package/src/app/api/[locale]/system/i18n/de/index.ts

@@ -0,0 +1,68 @@
+import { translations as builderTranslations } from "../../builder/i18n/de";
+import { translations as checkTranslations } from "../../check/i18n/de";
+import { translations as generatorsTranslations } from "../../generators/i18n/de";
+import { translations as releaseToolTranslations } from "../../release-tool/i18n/de";
+import { translations as unifiedInterfaceTranslations } from "../../unified-interface/i18n/de";
+import type { translations as enTranslations } from "../en";
+
+export const translations: typeof enTranslations = {
+  builder: builderTranslations,
+  check: checkTranslations,
+
+  dev: {
+    category: "Entwicklung",
+    typecheck: {
+      title: "Typprüfung überspringen",
+      description: "TypeScript-Typprüfung überspringen",
+      success: {
+        title: "Typprüfung bestanden",
+        description: "TypeScript-Typprüfung erfolgreich abgeschlossen",
+      },
+    },
+    lint: {
+      container: {
+        title: "Generator-Optionen",
+      },
+    },
+  },
+  generators: generatorsTranslations,
+
+  sideTasks: {
+    category: "Nebenaufgaben",
+    generators: {
+      generateTrpcRouter: {
+        title: "tRPC-Router generieren",
+        description: "tRPC-Router aus API-Endpunkten generieren",
+        tag: "tRPC",
+        container: {
+          title: "tRPC-Router-Generierung",
+          description: "tRPC-Router-Konfiguration generieren",
+        },
+        errors: {
+          validation: {
+            title: "Validierungsfehler",
+            description: "Ungültige tRPC-Router-Generierungsparameter",
+          },
+          internal: {
+            title: "Interner Fehler",
+            description:
+              "Bei der tRPC-Router-Generierung ist ein Fehler aufgetreten",
+          },
+          unauthorized: {
+            title: "Nicht autorisiert",
+            description:
+              "Sie haben keine Berechtigung, tRPC-Router zu generieren",
+          },
+        },
+        success: {
+          title: "tRPC-Router generiert",
+          description: "tRPC-Router wurde erfolgreich generiert",
+        },
+      },
+    },
+  },
+
+  releaseTool: releaseToolTranslations,
+
+  unifiedInterface: unifiedInterfaceTranslations,
+};

package/src/app/api/[locale]/system/i18n/en/index.ts

@@ -0,0 +1,65 @@
+import { translations as builderTranslations } from "../../builder/i18n/en";
+import { translations as checkTranslations } from "../../check/i18n/en";
+import { translations as generatorsTranslations } from "../../generators/i18n/en";
+import { translations as releaseToolTranslations } from "../../release-tool/i18n/en";
+import { translations as unifiedInterfaceTranslations } from "../../unified-interface/i18n/en";
+
+export const translations = {
+  builder: builderTranslations,
+  check: checkTranslations,
+
+  dev: {
+    category: "Development",
+    typecheck: {
+      title: "Skip Type Check",
+      description: "Skip TypeScript type checking",
+      success: {
+        title: "Type Check Passed",
+        description: "TypeScript type checking completed successfully",
+      },
+    },
+    lint: {
+      container: {
+        title: "Generator Options",
+      },
+    },
+  },
+  generators: generatorsTranslations,
+
+  sideTasks: {
+    category: "Side Tasks",
+    generators: {
+      generateTrpcRouter: {
+        title: "Generate tRPC Router",
+        description: "Generate tRPC router from API endpoints",
+        tag: "tRPC",
+        container: {
+          title: "tRPC Router Generation",
+          description: "Generate tRPC router configuration",
+        },
+        errors: {
+          validation: {
+            title: "Validation Error",
+            description: "Invalid tRPC router generation parameters",
+          },
+          internal: {
+            title: "Internal Error",
+            description: "An error occurred during tRPC router generation",
+          },
+          unauthorized: {
+            title: "Unauthorized",
+            description: "You don't have permission to generate tRPC router",
+          },
+        },
+        success: {
+          title: "tRPC Router Generated",
+          description: "tRPC router has been generated successfully",
+        },
+      },
+    },
+  },
+
+  releaseTool: releaseToolTranslations,
+
+  unifiedInterface: unifiedInterfaceTranslations,
+};

package/src/app/api/[locale]/system/i18n/pl/index.ts

@@ -0,0 +1,66 @@
+import { translations as builderTranslations } from "../../builder/i18n/pl";
+import { translations as checkTranslations } from "../../check/i18n/pl";
+import { translations as generatorsTranslations } from "../../generators/i18n/pl";
+import { translations as releaseToolTranslations } from "../../release-tool/i18n/pl";
+import { translations as unifiedInterfaceTranslations } from "../../unified-interface/i18n/pl";
+import type { translations as enTranslations } from "../en";
+
+export const translations: typeof enTranslations = {
+  builder: builderTranslations,
+  check: checkTranslations,
+
+  dev: {
+    category: "Rozwój",
+    typecheck: {
+      title: "Pomiń sprawdzanie typów",
+      description: "Pomiń sprawdzanie typów TypeScript",
+      success: {
+        title: "Sprawdzanie typów zakończone sukcesem",
+        description: "Sprawdzanie typów TypeScript zakończone pomyślnie",
+      },
+    },
+    lint: {
+      container: {
+        title: "Opcje generatora",
+      },
+    },
+  },
+  generators: generatorsTranslations,
+
+  sideTasks: {
+    category: "Zadania poboczne",
+    generators: {
+      generateTrpcRouter: {
+        title: "Generuj router tRPC",
+        description: "Generuj router tRPC z punktów końcowych API",
+        tag: "tRPC",
+        container: {
+          title: "Generowanie routera tRPC",
+          description: "Generuj konfigurację routera tRPC",
+        },
+        errors: {
+          validation: {
+            title: "Błąd walidacji",
+            description: "Nieprawidłowe parametry generowania routera tRPC",
+          },
+          internal: {
+            title: "Błąd wewnętrzny",
+            description: "Wystąpił błąd podczas generowania routera tRPC",
+          },
+          unauthorized: {
+            title: "Brak autoryzacji",
+            description: "Nie masz uprawnień do generowania routera tRPC",
+          },
+        },
+        success: {
+          title: "Router tRPC wygenerowany",
+          description: "Router tRPC został pomyślnie wygenerowany",
+        },
+      },
+    },
+  },
+
+  releaseTool: releaseToolTranslations,
+
+  unifiedInterface: unifiedInterfaceTranslations,
+};