@fireberry/cli 0.0.5-beta.9 → 0.2.1

package/CLAUDE.md

@@ -0,0 +1,156 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Overview
+
+`@fireberry/cli` is a command-line tool for managing Fireberry applications. It allows developers to initialize credentials, create new apps from templates, push components to the Fireberry platform, and install apps on Fireberry accounts.
+
+## Development Commands
+
+### Build and Development
+
+```bash
+npm run build          # Compile TypeScript to dist/
+npm run build:dev      # Clean, build, link globally, and make executable
+npm run dev            # Watch mode compilation
+npm run clean          # Remove dist/ directory
+```
+
+### Testing
+
+```bash
+npm test              # Run smoke test (verifies CLI --help works)
+```
+
+### Local Development
+
+```bash
+npm run build:dev     # Build and link CLI locally
+fireberry --help      # Test the linked CLI
+```
+
+### Publishing
+
+```bash
+npm run publish:beta  # Version bump (beta) and publish to npm with beta tag
+npm run publish:prod  # Publish to npm with latest tag
+```
+
+## Architecture
+
+### Module System
+
+- **Type**: ESM (ES Modules) with `"type": "module"` in package.json
+- **Module Resolution**: NodeNext
+- **Import Extensions**: All local imports must use `.js` extension (e.g., `import { foo } from "./bar.js"`)
+- **JSON Imports**: Use `with { type: "json" }` syntax (e.g., `import packageJson from "../../package.json" with { type: "json" }`)
+
+### CLI Entry Point
+
+- **Binary**: [dist/bin/fireberry.js](dist/bin/fireberry.js) (generated from [src/bin/fireberry.ts](src/bin/fireberry.ts))
+- **Framework**: Commander.js for command parsing and routing
+- **Error Handling**: Global error handler in [src/bin/fireberry.ts](src/bin/fireberry.ts) catches and formats errors
+
+### Command Structure
+
+Each CLI command is in [src/commands/](src/commands/):
+
+- **init**: Stores Fireberry API token in local config using `env-paths`
+- **create**: Creates new Fireberry app from templates with generated UUIDs
+- **push**: Validates manifest, zips components, uploads to Fireberry API
+- **install**: Installs app on user's Fireberry account
+- **delete**: Deletes app from Fireberry platform (requires confirmation)
+
+### Configuration System
+
+- **User Config**: Stored via `env-paths` ("Fireberry CLI") in OS-specific config directory
+- **Config File**: `config.json` with `{ apiToken, createdAt }`
+- **Environment**: [src/config/env.ts](src/config/env.ts) loads `.env` file from project root using dotenv
+
+### API Layer ([src/api/](src/api/))
+
+- **axios.ts**: Axios instance with automatic token injection via interceptors
+- **API URL Logic**:
+  - Beta versions (version contains "beta") → Uses `FIREBERRY_STAGING_URL` environment variable
+  - Production versions → `FIREBERRY_API_URL` or `https://api.fireberry.com/api/v3`
+- **Authentication**: Token passed via `tokenId` header (read from config in interceptor)
+- **requests.ts**: API endpoints (`createApp`, `pushComponents`, `installApp`, `deleteApp`)
+- **types.ts**: TypeScript interfaces for API requests/responses
+
+### Component System
+
+Component utilities in [src/utils/components.utils.ts](src/utils/components.utils.ts):
+
+- **Manifest Parsing**: YAML manifest loaded from `manifest.yml` in current directory
+- **Component Validation**: Checks paths exist, components are unique, validates required settings per component type
+- **Component Zipping**: Creates tar.gz archives of component builds (directories or single files)
+- **Component Types** ([src/constants/component-types.ts](src/constants/component-types.ts)):
+  - **record**: Record page component with required settings: `iconName` (string), `iconColor` (string), `objectType` (number)
+  - **global-menu**: Global menu component with required setting: `displayName` (string)
+  - **side-menu**: Side menu component with required settings: `icon` (string), `width` (string: "S" | "M" | "L")
+- **Manifest Structure**:
+  ```yaml
+  app:
+    id: "uuid"
+    name: "App Name"
+  components:
+    - type: record | global-menu | side-menu
+      title: component-name
+      id: "uuid"
+      path: relative/path/to/build
+      settings:
+        # For record type:
+        iconName: "icon-name"
+        iconColor: "#hexcolor"
+        objectType: 1
+        # For global-menu type:
+        displayName: "Menu Name"
+        # For side-menu type:
+        icon: "icon-name"
+        width: "S" | "M" | "L"
+  ```
+
+### Templates ([src/templates/](src/templates/))
+
+Templates use mustache-style placeholders (`{{appName}}`, `{{appId}}`, `{{componentId}}`):
+
+- **manifest.yml**: Default manifest with single component
+- **index.html**: Basic HTML template
+
+## Key Patterns
+
+### Error Handling
+
+- Commands throw errors which are caught by the global handler in [src/bin/fireberry.ts:47](src/bin/fireberry.ts#L47)
+- Errors are formatted with chalk.red and prefixed with "Error:" if not already present
+- API errors map HTTP status codes to user-friendly messages
+
+### User Feedback
+
+- Use `ora` spinners for long-running operations (start → succeed/fail)
+- Use `chalk` for colored output (cyan for highlights, gray for details, yellow for warnings)
+- Use `inquirer` for interactive prompts when arguments are missing
+
+### File Operations
+
+- Use `fs-extra` for all file operations (promisified, ensures directories exist)
+- Check `fs.pathExists()` before operations
+- Use `process.cwd()` as base for relative paths in user projects
+
+### Component Path Resolution
+
+Component paths in manifest.yml are relative to the current working directory, not the CLI installation directory. Example: `path: static/comp/build` resolves to `process.cwd() + "/static/comp/build"`.
+
+## Important Notes
+
+- **Manifest Required**: `push`, `install`, and `delete` commands must be run from a directory containing `manifest.yml`
+- **Token Required**: Most commands require prior `init` to store API token
+- **Component IDs**: Must be unique UUIDs within a manifest
+- **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)
+- **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/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Fireberry LTD
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/api/axios.js

@@ -46,7 +46,7 @@ export async function sendApiRequest(config) {
             let errorMessage;
             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/dist/api/requests.d.ts

@@ -1,4 +1,8 @@
 import "../config/env.js";
-import type { CreateAppRequest, ZippedComponent } from "./types.js";
-export declare const createApp: (data: CreateAppRequest) => Promise<void>;
-export declare const pushComponents: (appId: string, components: ZippedComponent[]) => Promise<void>;
+import type { Manifest, ZippedComponent } from "./types.js";
+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 startDebug: (appId: string, componentId: string, debugUrl: string, manifest: Manifest) => Promise<void>;
+export declare const stopDebug: (appId: string, componentId: string, manifest: Manifest) => Promise<void>;

package/dist/api/requests.js

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

package/dist/api/types.d.ts

@@ -1,5 +1,8 @@
+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 {
     message: string;
@@ -16,10 +19,38 @@ interface ManifestApp {
     name: string;
     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>;
 }
@@ -29,7 +60,7 @@ export interface Manifest {
 }
 export interface ZippedComponent {
     title: string;
-    key: string;
+    id: string;
     build: Buffer;
 }
 export {};

package/dist/bin/fireberry.js

@@ -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();
 program
     .name("fireberry")
@@ -31,6 +34,26 @@ program
     .action(async () => {
     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, url, options) => {
+    await runDebug(componentId, url, options);
+});
 program.parseAsync(process.argv).catch((err) => {
     const errorMessage = err instanceof Error
         ? err.message

package/dist/commands/create.js

@@ -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);
 function slugifyName(name) {
@@ -28,23 +29,26 @@ export async function runCreate({ name }) {
     }
     const slug = slugifyName(appName);
     const appId = uuidv4();
+    const componentId = uuidv4();
     const appDir = path.resolve(process.cwd(), slug);
     if (await fs.pathExists(appDir)) {
         throw new Error(`Already exists. ${chalk.yellow(slug)}`);
     }
     const spinner = ora(`Creating app "${chalk.cyan(appName)}"...`).start();
     try {
-        await createApp({ appId });
         await fs.ensureDir(appDir);
         const templatesDir = path.join(__dirname, "..", "..", "src", "templates");
         const manifestTemplate = await fs.readFile(path.join(templatesDir, "manifest.yml"), "utf-8");
         const htmlTemplate = await fs.readFile(path.join(templatesDir, "index.html"), "utf-8");
         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}`));
         console.log(chalk.gray(`App ID: ${appId}`));

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,54 @@
+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) {
+    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 === componentId);
+    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");
+        // 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/dist/commands/delete.d.ts

@@ -0,0 +1 @@
+export declare function runDelete(): Promise<void>;

package/dist/commands/delete.js

@@ -0,0 +1,31 @@
+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() {
+    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/dist/commands/install.d.ts

@@ -0,0 +1 @@
+export declare function runInstall(): Promise<void>;

package/dist/commands/install.js

@@ -0,0 +1,17 @@
+import ora from "ora";
+import { installApp } from "../api/requests.js";
+import { getManifest, validateManifestComponents, } from "../utils/components.utils.js";
+export async function runInstall() {
+    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/dist/commands/push.js

@@ -15,10 +15,10 @@ export async function runPush() {
             console.log(chalk.cyan("\nComponents ready to push:"));
             zippedComponents.forEach((comp, idx) => {
                 const sizeKB = (comp.build.length / 1024).toFixed(2);
-                console.log(chalk.gray(`  ${idx + 1}. ${comp.title} (${comp.key}) - ${sizeKB} KB`));
+                console.log(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 {

package/dist/constants/component-types.d.ts

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

package/dist/constants/component-types.js

@@ -0,0 +1,6 @@
+export const COMPONENT_TYPE = {
+    RECORD: "record",
+    GLOBAL_MENU: "global-menu",
+    SIDE_MENU: "side-menu",
+};
+export const BASE_SERVICE_URL = "/services/developer/app";

package/dist/constants/height-options.d.ts

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

package/dist/constants/height-options.js

@@ -0,0 +1 @@
+export const HEIGHT_OPTIONS = ["S", "M", "L", "XL"];

package/dist/utils/components.utils.d.ts

@@ -1,5 +1,6 @@
-import { Manifest, ManifestComponent, ZippedComponent } from "../api/types.js";
-export declare const getManifest: () => Promise<Manifest>;
-export declare const validateComponentBuild: (componentPath: string, comp: ManifestComponent) => Promise<void>;
+import { Manifest, ZippedComponent, UntypedManifestComponent } from "../api/types.js";
+export declare const getManifest: (basePath?: string) => Promise<Manifest>;
+export declare const validateComponentBuild: (componentPath: string, comp: UntypedManifestComponent) => Promise<void>;
 export declare const zipComponentBuild: (componentPath: string, title: string) => Promise<Buffer>;
+export declare const validateManifestComponents: (manifest: Manifest) => Promise<void>;
 export declare const handleComponents: (manifest: Manifest) => Promise<ZippedComponent[]>;