@fireberry/cli 0.2.0 → 0.2.2

package/CLAUDE.md

@@ -107,7 +107,7 @@ Component utilities in [src/utils/components.utils.ts](src/utils/components.util
         # For global-menu type:
         displayName: "Menu Name"
         # For side-menu type:
-        icon: "icon-name"
+        iconName: "icon-name"
         width: "S" | "M" | "L"
   ```
 
@@ -150,7 +150,7 @@ Component paths in manifest.yml are relative to the current working directory, n
 - **Component Settings Validation**: Each component type has required settings that are validated during `push`:
   - `record`: Must have `iconName`, `iconColor`, and `objectType`
   - `global-menu`: Must have `displayName`
-  - `side-menu`: Must have `icon` and `width` (S/M/L)
+  - `side-menu`: Must have `iconName` and `width` (S/M/L)
 - **Build Zipping**: Single files are wrapped in a directory before tar.gz creation
 - **Template Location**: Templates are resolved from `src/templates/` at compile time, copied to `dist/templates/`
 - **Delete Safety**: Delete command requires user confirmation before executing (cannot be undone)

package/dist/api/requests.d.ts

@@ -4,3 +4,4 @@ export declare const createApp: (manifest: Manifest) => Promise<void>;
 export declare const pushComponents: (appId: string, components: ZippedComponent[], manifest: Manifest) => Promise<void>;
 export declare const installApp: (manifest: Manifest) => Promise<void>;
 export declare const deleteApp: (manifest: Manifest) => Promise<void>;
+export declare const updateDebug: (componentId: string, manifest: Manifest, debugUrl?: string) => Promise<void>;

package/dist/api/requests.js

@@ -37,3 +37,12 @@ export const deleteApp = async (manifest) => {
         throw new Error(error instanceof Error ? error.message : "Unknown error");
     }
 };
+export const updateDebug = async (componentId, manifest, debugUrl) => {
+    const url = `${BASE_SERVICE_URL}/debug`;
+    try {
+        await api.post(url, { componentId, debugUrl, manifest });
+    }
+    catch (error) {
+        throw new Error(error instanceof Error ? error.message : "Unknown error");
+    }
+};

package/dist/api/types.d.ts

@@ -27,9 +27,10 @@ export interface RecordComponentSettings {
 }
 export interface GlobalMenuComponentSettings {
     displayName: string;
+    iconName?: string;
 }
 export interface SideMenuComponentSettings {
-    icon: string;
+    iconName: string;
     width: "S" | "M" | "L";
 }
 export type ComponentSettings = RecordComponentSettings | GlobalMenuComponentSettings | SideMenuComponentSettings;

package/dist/bin/fireberry.js

@@ -7,6 +7,7 @@ import packageJson from "../../package.json" with { type: "json" };
 import { runPush } from "../commands/push.js";
 import { runInstall } from "../commands/install.js";
 import { runDelete } from "../commands/delete.js";
+import { runDebug } from "../commands/debug.js";
 const program = new Command();
 program
     .name("fireberry")
@@ -44,6 +45,15 @@ program
     .action(async () => {
     await runDelete();
 });
+program
+    .command("debug")
+    .argument("<component-id>", "Component ID to debug")
+    .argument("[url]", "Debug URL in format localhost:[port]")
+    .option("--stop", "Stop debugging the component")
+    .description("Start or stop debugging a component")
+    .action(async (componentId, url, options) => {
+    await runDebug(componentId, url, options);
+});
 program.parseAsync(process.argv).catch((err) => {
     const errorMessage = err instanceof Error
         ? err.message

package/dist/commands/debug.d.ts

@@ -0,0 +1,3 @@
+export declare function runDebug(componentId: string, url?: string, options?: {
+    stop?: boolean;
+}): Promise<void>;

package/dist/commands/debug.js

@@ -0,0 +1,51 @@
+import ora from "ora";
+import chalk from "chalk";
+import { updateDebug } from "../api/requests.js";
+import { getManifest } from "../utils/components.utils.js";
+function validateDebugUrl(url) {
+    const localhostPattern = /^localhost:\d+$/;
+    if (!localhostPattern.test(url)) {
+        throw new Error("Invalid URL format. URL must be in format: localhost:[port] (e.g., localhost:3000)\n" +
+            "Do not include http:// or https://");
+    }
+}
+function validateComponentExists(manifest, componentId) {
+    const component = manifest.components?.find((comp) => comp.id.toLowerCase() === componentId.toLowerCase());
+    if (!component) {
+        throw new Error(`Component with ID "${componentId}" not found in manifest.\n` +
+            `Available components:\n` +
+            manifest.components
+                ?.map((comp) => `  - ${comp.title} (${comp.id})`)
+                .join("\n"));
+    }
+}
+export async function runDebug(componentId, url, options) {
+    const spinner = ora("Loading manifest...").start();
+    try {
+        const manifest = await getManifest();
+        spinner.succeed("Manifest loaded");
+        validateComponentExists(manifest, componentId);
+        if (options?.stop) {
+            spinner.start("Stopping debug mode...");
+            await updateDebug(componentId, manifest);
+            spinner.succeed(chalk.green(`Debug mode stopped for component: ${componentId}`));
+        }
+        else {
+            if (!url) {
+                throw new Error("URL is required when starting debug mode.\n" +
+                    `Usage: fireberry debug ${componentId} localhost:[port]`);
+            }
+            validateDebugUrl(url);
+            spinner.start(`Starting debug mode for component ${componentId}...`);
+            await updateDebug(componentId, manifest, url);
+            spinner.succeed(chalk.green(`Debug mode started!\n` +
+                `  Component: ${componentId}\n` +
+                `  URL: ${url}\n\n` +
+                `To stop debugging, run: ${chalk.cyan(`fireberry debug ${componentId} --stop`)}`));
+        }
+    }
+    catch (error) {
+        spinner.fail(options?.stop ? "Failed to stop debug mode" : "Failed to start debug mode");
+        throw error;
+    }
+}

package/dist/utils/components.utils.js

@@ -66,14 +66,17 @@ const validateGlobalMenuComponentSettings = (comp) => {
     if (typeof settings.displayName !== "string") {
         throw new Error(`Component "${comp.title}" (type: ${COMPONENT_TYPE.GLOBAL_MENU}) setting "displayName" must be a string`);
     }
+    if (settings.iconName && typeof settings.iconName !== "string") {
+        throw new Error(`Component "${comp.title}" (type: ${COMPONENT_TYPE.GLOBAL_MENU}) setting "iconName" must be a string`);
+    }
 };
 const validateSideMenuComponentSettings = (comp) => {
     const settings = comp.settings;
     if (!settings) {
         throw new Error(`Component "${comp.title}" (type: ${COMPONENT_TYPE.SIDE_MENU}) is missing required settings`);
     }
-    if (!settings.icon) {
-        throw new Error(`Component "${comp.title}" (type: ${COMPONENT_TYPE.SIDE_MENU}) setting "icon" must be a string`);
+    if (!settings.iconName) {
+        throw new Error(`Component "${comp.title}" (type: ${COMPONENT_TYPE.SIDE_MENU}) setting "iconName" must be a string`);
     }
     if (!settings.width) {
         throw new Error(`Component "${comp.title}" (type: ${COMPONENT_TYPE.SIDE_MENU}) setting "width" must be a S | M | L`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fireberry/cli",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Fireberry CLI tool",
   "type": "module",
   "author": "",

package/src/api/requests.ts

@@ -42,3 +42,16 @@ export const deleteApp = async (manifest: Manifest): Promise<void> => {
     throw new Error(error instanceof Error ? error.message : "Unknown error");
   }
 };
+
+export const updateDebug = async (
+  componentId: string,
+  manifest: Manifest,
+  debugUrl?: string
+): Promise<void> => {
+  const url = `${BASE_SERVICE_URL}/debug`;
+  try {
+    await api.post<void>(url, { componentId, debugUrl, manifest });
+  } catch (error) {
+    throw new Error(error instanceof Error ? error.message : "Unknown error");
+  }
+};

package/src/api/types.ts

@@ -33,10 +33,11 @@ export interface RecordComponentSettings {
 
 export interface GlobalMenuComponentSettings {
   displayName: string;
+  iconName?: string;
 }
 
 export interface SideMenuComponentSettings {
-  icon: string;
+  iconName: string;
   width: "S" | "M" | "L";
 }
 

package/src/bin/fireberry.ts

@@ -7,6 +7,7 @@ import packageJson from "../../package.json" with { type: "json" };
 import { runPush } from "../commands/push.js";
 import { runInstall } from "../commands/install.js";
 import { runDelete } from "../commands/delete.js";
+import { runDebug } from "../commands/debug.js";
 
 const program = new Command();
 
@@ -52,6 +53,16 @@ program
     await runDelete();
   });
 
+program
+  .command("debug")
+  .argument("<component-id>", "Component ID to debug")
+  .argument("[url]", "Debug URL in format localhost:[port]")
+  .option("--stop", "Stop debugging the component")
+  .description("Start or stop debugging a component")
+  .action(async (componentId: string, url?: string, options?: { stop?: boolean }) => {
+    await runDebug(componentId, url, options);
+  });
+
 program.parseAsync(process.argv).catch((err: unknown) => {
   const errorMessage = err instanceof Error 
     ? err.message

package/src/commands/debug.ts

@@ -0,0 +1,86 @@
+import ora from "ora";
+import chalk from "chalk";
+import { updateDebug } from "../api/requests.js";
+import { getManifest } from "../utils/components.utils.js";
+import { Manifest, ManifestComponent } from "../api/types.js";
+
+function validateDebugUrl(url: string): void {
+  const localhostPattern = /^localhost:\d+$/;
+
+  if (!localhostPattern.test(url)) {
+    throw new Error(
+      "Invalid URL format. URL must be in format: localhost:[port] (e.g., localhost:3000)\n" +
+        "Do not include http:// or https://"
+    );
+  }
+}
+
+function validateComponentExists(
+  manifest: Manifest,
+  componentId: string
+): void {
+  const component = manifest.components?.find(
+    (comp: ManifestComponent) =>
+      comp.id.toLowerCase() === componentId.toLowerCase()
+  );
+
+  if (!component) {
+    throw new Error(
+      `Component with ID "${componentId}" not found in manifest.\n` +
+        `Available components:\n` +
+        manifest.components
+          ?.map((comp: ManifestComponent) => `  - ${comp.title} (${comp.id})`)
+          .join("\n")
+    );
+  }
+}
+
+export async function runDebug(
+  componentId: string,
+  url?: string,
+  options?: { stop?: boolean }
+): Promise<void> {
+  const spinner = ora("Loading manifest...").start();
+
+  try {
+    const manifest = await getManifest();
+    spinner.succeed("Manifest loaded");
+
+    validateComponentExists(manifest, componentId);
+
+    if (options?.stop) {
+      spinner.start("Stopping debug mode...");
+      await updateDebug(componentId, manifest);
+      spinner.succeed(
+        chalk.green(`Debug mode stopped for component: ${componentId}`)
+      );
+    } else {
+      if (!url) {
+        throw new Error(
+          "URL is required when starting debug mode.\n" +
+            `Usage: fireberry debug ${componentId} localhost:[port]`
+        );
+      }
+
+      validateDebugUrl(url);
+
+      spinner.start(`Starting debug mode for component ${componentId}...`);
+      await updateDebug(componentId, manifest, url);
+      spinner.succeed(
+        chalk.green(
+          `Debug mode started!\n` +
+            `  Component: ${componentId}\n` +
+            `  URL: ${url}\n\n` +
+            `To stop debugging, run: ${chalk.cyan(
+              `fireberry debug ${componentId} --stop`
+            )}`
+        )
+      );
+    }
+  } catch (error) {
+    spinner.fail(
+      options?.stop ? "Failed to stop debug mode" : "Failed to start debug mode"
+    );
+    throw error;
+  }
+}

package/src/utils/components.utils.ts

@@ -13,7 +13,7 @@ import {
   SideMenuComponentSettings,
 } from "../api/types.js";
 import { COMPONENT_TYPE } from "../constants/component-types.js";
-import { HEIGHT_OPTIONS } from "../constants/height-options.js";
+import { HEIGHT_OPTIONS, HeightOption } from "../constants/height-options.js";
 
 export const getManifest = async (basePath?: string): Promise<Manifest> => {
   const manifestPath = path.join(basePath || process.cwd(), "manifest.yml");
@@ -90,13 +90,17 @@ const validateRecordComponentSettings = (
   }
   if (!settings.height) {
     throw new Error(
-      `Component "${comp.title}" (type: ${COMPONENT_TYPE.RECORD}) setting "height" must be one of: ${HEIGHT_OPTIONS.join(" | ")}`
+      `Component "${comp.title}" (type: ${
+        COMPONENT_TYPE.RECORD
+      }) setting "height" must be one of: ${HEIGHT_OPTIONS.join(" | ")}`
     );
   }
 
-  if (!HEIGHT_OPTIONS.includes(settings.height as any)) {
+  if (!HEIGHT_OPTIONS.includes(settings.height as HeightOption)) {
     throw new Error(
-      `Component "${comp.title}" (type: ${COMPONENT_TYPE.RECORD}) setting "height" must be one of: ${HEIGHT_OPTIONS.join(" | ")}`
+      `Component "${comp.title}" (type: ${
+        COMPONENT_TYPE.RECORD
+      }) setting "height" must be one of: ${HEIGHT_OPTIONS.join(" | ")}`
     );
   }
 };
@@ -125,6 +129,12 @@ const validateGlobalMenuComponentSettings = (
       `Component "${comp.title}" (type: ${COMPONENT_TYPE.GLOBAL_MENU}) setting "displayName" must be a string`
     );
   }
+
+  if (settings.iconName && typeof settings.iconName !== "string") {
+    throw new Error(
+      `Component "${comp.title}" (type: ${COMPONENT_TYPE.GLOBAL_MENU}) setting "iconName" must be a string`
+    );
+  }
 };
 
 const validateSideMenuComponentSettings = (
@@ -140,9 +150,9 @@ const validateSideMenuComponentSettings = (
     );
   }
 
-  if (!settings.icon) {
+  if (!settings.iconName) {
     throw new Error(
-      `Component "${comp.title}" (type: ${COMPONENT_TYPE.SIDE_MENU}) setting "icon" must be a string`
+      `Component "${comp.title}" (type: ${COMPONENT_TYPE.SIDE_MENU}) setting "iconName" must be a string`
     );
   }