@fireberry/cli 0.0.5-beta.9 → 0.2.1

package/dist/utils/components.utils.js

@@ -4,10 +4,13 @@ import yaml from "js-yaml";
 import chalk from "chalk";
 import * as tar from "tar";
 import os from "node:os";
-export const getManifest = async () => {
-    const manifestPath = path.join(process.cwd(), "manifest.yml");
+import { COMPONENT_TYPE } from "../constants/component-types.js";
+import { HEIGHT_OPTIONS } from "../constants/height-options.js";
+export const getManifest = async (basePath) => {
+    const manifestPath = path.join(basePath || process.cwd(), "manifest.yml");
+    const searchDir = basePath || process.cwd();
     if (!(await fs.pathExists(manifestPath))) {
-        throw new Error(`No manifest.yml found at ${chalk.yellow(process.cwd())}.\n` +
+        throw new Error(`No manifest.yml found at ${chalk.yellow(searchDir)}.\n` +
             `Please run this command from your Fireberry app directory.`);
     }
     const manifestContent = await fs.readFile(manifestPath, "utf-8");
@@ -20,6 +23,82 @@ export const getManifest = async () => {
     }
     return manifest;
 };
+const validateRecordComponentSettings = (comp) => {
+    const settings = comp.settings;
+    if (!settings) {
+        throw new Error(`Component "${comp.title}" (type: ${COMPONENT_TYPE.RECORD}) is missing required settings`);
+    }
+    const requiredFields = [
+        "iconName",
+        "iconColor",
+        "objectType",
+        "height",
+    ];
+    for (const fieldName of requiredFields) {
+        if (settings[fieldName] === undefined || settings[fieldName] === null) {
+            throw new Error(`Component "${comp.title}" (type: ${COMPONENT_TYPE.RECORD}) is missing required setting: ${fieldName}`);
+        }
+    }
+    if (typeof settings.iconName !== "string") {
+        throw new Error(`Component "${comp.title}" (type: ${COMPONENT_TYPE.RECORD}) setting "iconName" must be a string`);
+    }
+    if (typeof settings.iconColor !== "string") {
+        throw new Error(`Component "${comp.title}" (type: ${COMPONENT_TYPE.RECORD}) setting "iconColor" must be a string`);
+    }
+    if (typeof settings.objectType !== "number") {
+        throw new Error(`Component "${comp.title}" (type: ${COMPONENT_TYPE.RECORD}) setting "objectType" must be a number`);
+    }
+    if (!settings.height) {
+        throw new Error(`Component "${comp.title}" (type: ${COMPONENT_TYPE.RECORD}) setting "height" must be one of: ${HEIGHT_OPTIONS.join(" | ")}`);
+    }
+    if (!HEIGHT_OPTIONS.includes(settings.height)) {
+        throw new Error(`Component "${comp.title}" (type: ${COMPONENT_TYPE.RECORD}) setting "height" must be one of: ${HEIGHT_OPTIONS.join(" | ")}`);
+    }
+};
+const validateGlobalMenuComponentSettings = (comp) => {
+    const settings = comp.settings;
+    if (!settings) {
+        throw new Error(`Component "${comp.title}" (type: ${COMPONENT_TYPE.GLOBAL_MENU}) is missing required settings`);
+    }
+    if (!settings.displayName) {
+        throw new Error(`Component "${comp.title}" (type: ${COMPONENT_TYPE.GLOBAL_MENU}) is missing required setting: displayName`);
+    }
+    if (typeof settings.displayName !== "string") {
+        throw new Error(`Component "${comp.title}" (type: ${COMPONENT_TYPE.GLOBAL_MENU}) setting "displayName" 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.width) {
+        throw new Error(`Component "${comp.title}" (type: ${COMPONENT_TYPE.SIDE_MENU}) setting "width" must be a S | M | L`);
+    }
+    if (settings.width !== "S" &&
+        settings.width !== "M" &&
+        settings.width !== "L") {
+        throw new Error(`Component "${comp.title}" (type: ${COMPONENT_TYPE.SIDE_MENU}) setting "width" must be a S | M | L`);
+    }
+};
+const validateComponentSettings = (comp) => {
+    switch (comp.type) {
+        case COMPONENT_TYPE.RECORD:
+            validateRecordComponentSettings(comp);
+            break;
+        case COMPONENT_TYPE.GLOBAL_MENU:
+            validateGlobalMenuComponentSettings(comp);
+            break;
+        case COMPONENT_TYPE.SIDE_MENU:
+            validateSideMenuComponentSettings(comp);
+            break;
+        default:
+            throw new Error(`Component "${comp.title}" has unsupported type: ${comp.type}. Supported types: ${COMPONENT_TYPE.RECORD}, ${COMPONENT_TYPE.GLOBAL_MENU}`);
+    }
+};
 export const validateComponentBuild = async (componentPath, comp) => {
     if (!(await fs.pathExists(componentPath))) {
         throw new Error(`Component "${comp.title}" path does not exist: ${chalk.yellow(componentPath)}\n` + `Make sure the path in manifest.yml is correct.`);
@@ -28,9 +107,10 @@ export const validateComponentBuild = async (componentPath, comp) => {
     if (stats.isDirectory()) {
         const files = await fs.readdir(componentPath);
         if (files.length === 0) {
-            throw new Error(`Component <${comp.key}> at: /${comp.path} not found`);
+            throw new Error(`Component <${comp.id}> at: /${comp.path} not found`);
         }
     }
+    validateComponentSettings(comp);
 };
 export const zipComponentBuild = async (componentPath, title) => {
     const tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), "fireberry-"));
@@ -64,23 +144,30 @@ export const zipComponentBuild = async (componentPath, title) => {
         throw error;
     }
 };
-export const handleComponents = async (manifest) => {
+export const validateManifestComponents = async (manifest) => {
     const components = manifest.components;
     if (!components || components.length === 0) {
-        return [];
+        throw new Error("No components found in manifest");
     }
-    const keys = components.map((comp) => comp.key);
-    if (new Set(keys).size !== keys.length) {
-        throw new Error("All component keys must be unique");
+    const ids = components.map((comp) => comp.id);
+    if (new Set(ids).size !== ids.length) {
+        throw new Error("All component ids must be unique");
     }
-    const zippedComponents = [];
     for (const comp of components) {
         const componentPath = path.join(process.cwd(), comp.path);
         await validateComponentBuild(componentPath, comp);
+    }
+};
+export const handleComponents = async (manifest) => {
+    await validateManifestComponents(manifest);
+    const components = manifest.components;
+    const zippedComponents = [];
+    for (const comp of components) {
+        const componentPath = path.join(process.cwd(), comp.path);
         const buildBuffer = await zipComponentBuild(componentPath, comp.title);
         zippedComponents.push({
             title: comp.title,
-            key: comp.key,
+            id: comp.id,
             build: buildBuffer,
         });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fireberry/cli",
-  "version": "0.0.5-beta.9",
+  "version": "0.2.1",
   "description": "Fireberry CLI tool",
   "type": "module",
   "author": "",

package/src/api/axios.ts

@@ -59,7 +59,7 @@ export async function sendApiRequest<T = any>(
 
       switch (status) {
         case 401:
-          console.log(error.response?.data?.message || error.message);
+          console.log(error.response?.data?.message || error.message); // TODO: remove this
           errorMessage = "Unauthorized user.";
           break;
         case 500:

package/src/api/requests.ts

@@ -1,11 +1,12 @@
 import "../config/env.js";
+import { BASE_SERVICE_URL } from "../constants/component-types.js";
 import { api } from "./axios.js";
-import type { CreateAppRequest, ZippedComponent } from "./types.js";
+import type { Manifest, ZippedComponent } from "./types.js";
 
-export const createApp = async (data: CreateAppRequest): Promise<void> => {
-  const url = "/services/developer/create";
+export const createApp = async (manifest: Manifest): Promise<void> => {
+  const url = `${BASE_SERVICE_URL}/create`;
   try {
-    await api.post<void>(url, data);
+    await api.post<void>(url, { manifest });
   } catch (error) {
     throw new Error(error instanceof Error ? error.message : "Unknown error");
   }
@@ -13,11 +14,57 @@ export const createApp = async (data: CreateAppRequest): Promise<void> => {
 
 export const pushComponents = async (
   appId: string,
-  components: ZippedComponent[]
+  components: ZippedComponent[],
+  manifest: Manifest
 ): Promise<void> => {
-  const url = `/services/developer/push`;
+  const url = `${BASE_SERVICE_URL}/push`;
   try {
-    await api.post<void>(url, { appId, components });
+    await api.post<void>(url, { appId, components, manifest });
+  } catch (error) {
+    throw new Error(error instanceof Error ? error.message : "Unknown error");
+  }
+};
+
+export const installApp = async (manifest: Manifest): Promise<void> => {
+  const url = `${BASE_SERVICE_URL}/install`;
+  try {
+    await api.post<void>(url, { manifest }, { timeout: 300000 }); // 5 minutes
+  } catch (error) {
+    throw new Error(error instanceof Error ? error.message : "Unknown error");
+  }
+};
+
+export const deleteApp = async (manifest: Manifest): Promise<void> => {
+  const url = `${BASE_SERVICE_URL}/delete`;
+  try {
+    await api.delete<void>(url, { manifest });
+  } catch (error) {
+    throw new Error(error instanceof Error ? error.message : "Unknown error");
+  }
+};
+
+export const startDebug = async (
+  appId: string,
+  componentId: string,
+  debugUrl: string,
+  manifest: Manifest
+): Promise<void> => {
+  const url = `${BASE_SERVICE_URL}/debug`;
+  try {
+    await api.post<void>(url, { appId, componentId, debugUrl, manifest });
+  } catch (error) {
+    throw new Error(error instanceof Error ? error.message : "Unknown error");
+  }
+};
+
+export const stopDebug = async (
+  appId: string,
+  componentId: string,
+  manifest: Manifest
+): Promise<void> => {
+  const url = `${BASE_SERVICE_URL}/debug`;
+  try {
+    await api.delete<void>(url, { appId, componentId, manifest });
   } catch (error) {
     throw new Error(error instanceof Error ? error.message : "Unknown error");
   }

package/src/api/types.ts

@@ -1,5 +1,9 @@
+import { COMPONENT_TYPE } from "../constants/component-types.js";
+import { HeightOption } from "../constants/height-options.js";
+
 export interface CreateAppRequest {
   appId: string;
+  componentId: string;
 }
 
 export interface ApiError {
@@ -20,10 +24,49 @@ interface ManifestApp {
   description?: string;
 }
 
-export interface ManifestComponent {
+export interface RecordComponentSettings {
+  iconName: string;
+  iconColor: string;
+  objectType: number;
+  height: HeightOption;
+}
+
+export interface GlobalMenuComponentSettings {
+  displayName: string;
+}
+
+export interface SideMenuComponentSettings {
+  icon: string;
+  width: "S" | "M" | "L";
+}
+
+export type ComponentSettings =
+  | RecordComponentSettings
+  | GlobalMenuComponentSettings
+  | SideMenuComponentSettings;
+
+export interface BaseManifestComponent {
+  title: string;
+  id: string;
+  path: string;
+}
+
+export interface RecordComponent extends BaseManifestComponent {
+  type: typeof COMPONENT_TYPE.RECORD;
+  settings: RecordComponentSettings;
+}
+
+export interface GlobalMenuComponent extends BaseManifestComponent {
+  type: typeof COMPONENT_TYPE.GLOBAL_MENU;
+  settings: GlobalMenuComponentSettings;
+}
+
+export type ManifestComponent = RecordComponent | GlobalMenuComponent;
+
+export interface UntypedManifestComponent {
   type: string;
   title: string;
-  key: string;
+  id: string;
   path: string;
   settings?: Record<string, unknown>;
 }
@@ -35,6 +78,6 @@ export interface Manifest {
 
 export interface ZippedComponent {
   title: string;
-  key: string;
+  id: string;
   build: Buffer;
 }

package/src/bin/fireberry.ts

@@ -5,6 +5,9 @@ import { runInit } from "../commands/init.js";
 import { runCreate } from "../commands/create.js";
 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();
 
@@ -37,6 +40,29 @@ program
     await runPush();
   });
 
+program.command("install")
+    .description("Install app on your Fireberry account")
+    .action(async () => {
+      await runInstall();
+    });
+
+program
+  .command("delete")
+  .description("Delete a Fireberry app")
+  .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: 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/create.ts

@@ -6,6 +6,7 @@ import { fileURLToPath } from "node:url";
 import ora from "ora";
 import chalk from "chalk";
 import { createApp } from "../api/requests.js";
+import { getManifest } from "../utils/components.utils.js";
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
@@ -40,6 +41,7 @@ export async function runCreate({ name }: CreateOptions): Promise<void> {
 
   const slug = slugifyName(appName);
   const appId = uuidv4();
+  const componentId = uuidv4();
   const appDir = path.resolve(process.cwd(), slug);
 
   if (await fs.pathExists(appDir)) {
@@ -49,8 +51,6 @@ export async function runCreate({ name }: CreateOptions): Promise<void> {
   const spinner = ora(`Creating app "${chalk.cyan(appName)}"...`).start();
 
   try {
-    await createApp({ appId });
-
     await fs.ensureDir(appDir);
 
     const templatesDir = path.join(__dirname, "..", "..", "src", "templates");
@@ -65,12 +65,16 @@ export async function runCreate({ name }: CreateOptions): Promise<void> {
 
     const manifestContent = manifestTemplate
       .replace(/{{appName}}/g, appName)
-      .replace(/{{appId}}/g, appId);
+      .replace(/{{appId}}/g, appId)
+      .replace(/{{componentId}}/g, componentId);
 
     const htmlContent = htmlTemplate.replace(/{{appName}}/g, appName);
 
     await fs.writeFile(path.join(appDir, "manifest.yml"), manifestContent);
     await fs.writeFile(path.join(appDir, "index.html"), htmlContent);
+    const manifest = await getManifest(appDir);
+
+    await createApp(manifest);
 
     spinner.succeed(`Successfully created "${chalk.cyan(appName)}" app!`);
     console.log(chalk.gray(`📁 Location: ${appDir}`));

package/src/commands/debug.ts

@@ -0,0 +1,84 @@
+import ora from "ora";
+import chalk from "chalk";
+import { startDebug, stopDebug } from "../api/requests.js";
+import { getManifest } from "../utils/components.utils.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: any, componentId: string): void {
+  const component = manifest.components?.find(
+    (comp: any) => comp.id === componentId
+  );
+
+  if (!component) {
+    throw new Error(
+      `Component with ID "${componentId}" not found in manifest.\n` +
+        `Available components:\n` +
+        manifest.components
+          ?.map((comp: any) => `  - ${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");
+
+    // Validate component exists
+    validateComponentExists(manifest, componentId);
+
+    if (options?.stop) {
+      // Stop debugging
+      spinner.start("Stopping debug mode...");
+      await stopDebug(manifest.app.id, componentId, manifest);
+      spinner.succeed(
+        chalk.green(`Debug mode stopped for component: ${componentId}`)
+      );
+    } else {
+      // Start debugging
+      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 startDebug(manifest.app.id, componentId, url, manifest);
+      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/commands/delete.ts

@@ -0,0 +1,40 @@
+import ora from "ora";
+import chalk from "chalk";
+import inquirer from "inquirer";
+import { deleteApp } from "../api/requests.js";
+import { getManifest } from "../utils/components.utils.js";
+
+export async function runDelete(): Promise<void> {
+  const spinner = ora("Loading manifest...").start();
+
+  try {
+    const manifest = await getManifest();
+    spinner.stop();
+
+    const confirmAnswer = await inquirer.prompt([
+      {
+        type: "confirm",
+        name: "confirm",
+        message: `Are you sure you want to delete app ${chalk.yellow(
+          manifest.app.name
+        )} (${chalk.gray(manifest.app.id)})? This action cannot be undone.`,
+        default: false,
+      },
+    ]);
+
+    if (!confirmAnswer.confirm) {
+      console.log(chalk.gray("Delete operation cancelled."));
+      return;
+    }
+
+    spinner.start(`Deleting app "${chalk.cyan(manifest.app.name)}"...`);
+
+    await deleteApp(manifest);
+    spinner.succeed(
+      `Successfully deleted app "${chalk.cyan(manifest.app.name)}"`
+    );
+  } catch (error) {
+    spinner.fail("Failed to delete app");
+    throw error;
+  }
+}

package/src/commands/install.ts

@@ -0,0 +1,23 @@
+import ora from "ora";
+import { installApp } from "../api/requests.js";
+import {
+  getManifest,
+  validateManifestComponents,
+} from "../utils/components.utils.js";
+
+export async function runInstall(): Promise<void> {
+  const spinner = ora("Loading manifest...").start();
+
+  try {
+    const manifest = await getManifest();
+
+    await validateManifestComponents(manifest);
+
+    spinner.start("Installing app on Fireberry...");
+    await installApp(manifest);
+    spinner.succeed("App installed successfully");
+  } catch (error) {
+    spinner.fail("Installation failed");
+    throw error;
+  }
+}

package/src/commands/push.ts

@@ -24,13 +24,13 @@ export async function runPush(): Promise<void> {
       zippedComponents.forEach((comp, idx) => {
         const sizeKB = (comp.build.length / 1024).toFixed(2);
         console.log(
-          chalk.gray(`  ${idx + 1}. ${comp.title} (${comp.key}) - ${sizeKB} KB`)
+          chalk.gray(`  ${idx + 1}. ${comp.title} (${comp.id}) - ${sizeKB} KB`)
         );
       });
 
       spinner.start("Uploading to Fireberry...");
 
-      await pushComponents(manifest.app.id, zippedComponents);
+      await pushComponents(manifest.app.id, zippedComponents, manifest);
       spinner.succeed("Components pushed successfully");
     } else {
       spinner.succeed("No components to push");

package/src/constants/component-types.ts

@@ -0,0 +1,10 @@
+export const COMPONENT_TYPE = {
+  RECORD: "record",
+  GLOBAL_MENU: "global-menu",
+  SIDE_MENU: "side-menu",
+} as const;
+
+export type ComponentType =
+  (typeof COMPONENT_TYPE)[keyof typeof COMPONENT_TYPE];
+
+export const BASE_SERVICE_URL = "/services/developer/app";

package/src/constants/height-options.ts

@@ -0,0 +1,3 @@
+export const HEIGHT_OPTIONS = ["S", "M", "L", "XL"] as const;
+
+export type HeightOption = (typeof HEIGHT_OPTIONS)[number];

package/src/templates/manifest.yml

@@ -5,6 +5,10 @@ app:
 components:
   - type: record
     title: my-first-component
-    key: comp
+    id: "{{componentId}}"
     path: static/comp/build
-    settings: {}
+    settings:
+      iconName: "related-single"
+      iconColor: "#7aae7f"
+      objectType: 0
+      height: "M"