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

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.17",
   "description": "Fireberry CLI tool",
   "type": "module",
   "author": "",

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}`