@fireberry/cli 0.0.5-beta.16 → 0.0.5-beta.18

package/CLAUDE.md

@@ -9,6 +9,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
 ## Development Commands
 
 ### Build and Development
+
 ```bash
 npm run build          # Compile TypeScript to dist/
 npm run build:dev      # Clean, build, link globally, and make executable
@@ -17,17 +18,20 @@ 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
@@ -36,84 +40,117 @@ 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`)
+- **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
+- **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
+    - type: record | global-menu | side-menu
       title: component-name
       id: "uuid"
       path: relative/path/to/build
-      settings: {...}
+      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` and `install` commands must be run from a directory containing `manifest.yml`
+- **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/dist/api/requests.js

@@ -30,7 +30,7 @@ export const installApp = async (manifest) => {
 export const deleteApp = async (manifest) => {
     const url = `/services/developer/delete`;
     try {
-        await api.delete(url, manifest);
+        await api.delete(url, { manifest });
     }
     catch (error) {
         throw new Error(error instanceof Error ? error.message : "Unknown error");

package/dist/api/types.d.ts

@@ -25,7 +25,11 @@ export interface RecordComponentSettings {
 export interface GlobalMenuComponentSettings {
     displayName: string;
 }
-export type ComponentSettings = RecordComponentSettings | GlobalMenuComponentSettings;
+export interface SideMenuComponentSettings {
+    icon: string;
+    width: "S" | "M" | "L";
+}
+export type ComponentSettings = RecordComponentSettings | GlobalMenuComponentSettings | SideMenuComponentSettings;
 export interface BaseManifestComponent {
     title: string;
     id: string;

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

@@ -1,5 +1,6 @@
 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];

package/dist/constants/component-types.js

@@ -1,4 +1,5 @@
 export const COMPONENT_TYPE = {
     RECORD: "record",
     GLOBAL_MENU: "global-menu",
+    SIDE_MENU: "side-menu",
 };

package/dist/utils/components.utils.js

@@ -58,6 +58,23 @@ const validateGlobalMenuComponentSettings = (comp) => {
         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:
@@ -66,6 +83,9 @@ const validateComponentSettings = (comp) => {
         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}`);
     }

package/package.json

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

package/src/api/requests.ts

@@ -35,7 +35,7 @@ export const installApp = async (manifest: Manifest): Promise<void> => {
 export const deleteApp = async (manifest: Manifest): Promise<void> => {
   const url = `/services/developer/delete`;
   try {
-    await api.delete<void>(url, manifest);
+    await api.delete<void>(url, { manifest });
   } catch (error) {
     throw new Error(error instanceof Error ? error.message : "Unknown error");
   }

package/src/api/types.ts

@@ -32,9 +32,15 @@ export interface GlobalMenuComponentSettings {
   displayName: string;
 }
 
+export interface SideMenuComponentSettings {
+  icon: string;
+  width: "S" | "M" | "L";
+}
+
 export type ComponentSettings =
   | RecordComponentSettings
-  | GlobalMenuComponentSettings;
+  | GlobalMenuComponentSettings
+  | SideMenuComponentSettings;
 
 export interface BaseManifestComponent {
   title: string;

package/src/constants/component-types.ts

@@ -1,6 +1,8 @@
 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 type ComponentType =
+  (typeof COMPONENT_TYPE)[keyof typeof COMPONENT_TYPE];

package/src/utils/components.utils.ts

@@ -10,6 +10,7 @@ import {
   UntypedManifestComponent,
   RecordComponentSettings,
   GlobalMenuComponentSettings,
+  SideMenuComponentSettings,
 } from "../api/types.js";
 import { COMPONENT_TYPE } from "../constants/component-types.js";
 
@@ -112,6 +113,42 @@ const validateGlobalMenuComponentSettings = (
   }
 };
 
+const validateSideMenuComponentSettings = (
+  comp: UntypedManifestComponent
+): void => {
+  const settings = comp.settings as
+    | Partial<SideMenuComponentSettings>
+    | undefined;
+
+  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: UntypedManifestComponent): void => {
   switch (comp.type) {
     case COMPONENT_TYPE.RECORD:
@@ -120,6 +157,9 @@ const validateComponentSettings = (comp: UntypedManifestComponent): void => {
     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}`