rapida-partner 1.0.0

package/src/interfaces/layout-dashboard.interface.ts

@@ -0,0 +1,52 @@
+import type { IApiRequest } from "./form-input.interface";
+import type { IBusinessRule } from "./project.interface";
+
+export interface IDashboard {
+  componentType: "dashboard";
+  id: string;
+  title: string;
+  icon?: string;
+  guards?: "isAuthenticated" | "isAuthorized";
+  businessRules?: IBusinessRule[];
+  userStory?: string;
+  layout: IDashboardSection[];
+}
+
+export interface IDashboardSection {
+  id: string;
+  title?: string;
+  columns: number;
+  widgets: IDashboardWidget[];
+}
+
+export interface IDashboardWidget {
+  id: string;
+  title: string;
+  type: "stats" | "chart" | "table" | "list" | "component";
+  width: 1 | 2 | 3 | 4 | 6 | 12; // Colunas que o widget ocupa em um grid de 12 colunas
+  height?: "auto" | "small" | "medium" | "large";
+  dataSource?: IApiRequest;
+  refreshInterval?: number; // Em segundos
+  component?: {
+    type: "dataTable" | "dataGrid" | "dataCard" | "dataChart";
+    config: any; // Referência para outra configuração de componente
+  };
+  statsConfig?: {
+    property: string;
+    format?: string;
+    icon?: string;
+    subtitle?: string;
+    trend?: {
+      property: string;
+      upIsGood?: boolean;
+    };
+  };
+  chartConfig?: {
+    type: "line" | "bar" | "pie" | "doughnut" | "radar";
+    properties: {
+      x: string;
+      y: string | string[];
+    };
+    options?: any; // Opções específicas do chart
+  };
+}

package/src/interfaces/layout-panel.interface.ts

@@ -0,0 +1,45 @@
+export interface IPanel {
+  componentType: "panel";
+  id: string;
+  title?: string;
+  subtitle?: string;
+  userStory?: string;
+  icon?: string;
+  collapsible?: boolean;
+  collapsed?: boolean;
+  headerActions?: IPanelAction[];
+  content: {
+    type: "component" | "html" | "markdown";
+    component?: {
+      type: "dataTable" | "dataGrid" | "dataCard" | "dataChart" | "form";
+      config: any; // Referência para outra configuração de componente
+    };
+    html?: string;
+    markdown?: string;
+  };
+  styling?: {
+    variant?: "default" | "outlined" | "elevated" | "flat";
+    padding?: "none" | "small" | "medium" | "large";
+    maxHeight?: string;
+    scrollable?: boolean;
+  };
+}
+
+export interface IPanelAction {
+  icon?: string;
+  label?: string;
+  action: {
+    type: "link" | "request" | "event";
+    link?: {
+      route: string;
+    };
+    request?: {
+      endpoint: string;
+      method: "GET" | "POST" | "PUT" | "DELETE";
+    };
+    event?: {
+      name: string;
+      data?: any;
+    };
+  };
+}

package/src/interfaces/list.interface.ts

@@ -0,0 +1,50 @@
+import type { IApiRequest } from "./form-input.interface";
+import type { IBusinessRule } from "./project.interface";
+
+export interface IList {
+    componentType: "list";
+    id: string; // named according to component file name (<id>.<componentType>.ts)
+    title: string;
+    userStory?: string;
+    guards?: string[];
+    dataSource: IApiRequest;
+    businessRules?: IBusinessRule[];
+    properties: {
+        property: string; // property taken from dataSource response. e.g.: "email"
+        label?: string; // label to property. e.g.: "E-mail"
+        type?: "title" | "subtitle" | "description" | "video" | "image" | "images" | "icon";
+        isHtml?: boolean;
+        isLink?: boolean;
+        isTimestamp?: boolean;
+        callToAction?: {
+            link: string; // e.g.: "/user"
+            usePropertyAsQuery?: boolean; // if true then "/user/<email>"
+        };
+    }[]; // properties taken from dataSource
+    cardAsALink?: {
+        link: string; // e.g.: "/user"
+        propertiesAsQueryParam?: string[]; // if, for example, ["_id", "email"], then "/user?_id=value&email=value"
+        propertiesAsPathParam?: string[]; // if, for example, ["_id", "email"], then "/user/<_id>/<email>"
+    };
+    callsToActionMenu?: {
+        icon: string; // Material icons e.g: "pencil"
+        label: string; // e.g: "Editar"
+        action: {
+            link: { // frontend url to be redirected on action completition
+                endpoint: string; // e.g.: "/user"
+                propertiesAsQueryParam?: string[]; // if, for example, ["_id", "email"], then "/user?_id=value&email=value"
+                propertiesAsPathParam?: string[]; // if, for example, ["_id", "email"], then "/user/<_id>/<email>"
+            };
+            request?: { // backend request endpoint that must be processed before link redirection
+                endpoint: string; // e.g.: "/user"
+                propertiesAsQueryParam?: string[]; // if, for example, ["_id", "email"], then "/user?_id=value&email=value"
+                propertiesAsPathParam?: string[]; // if, for example, ["_id", "email"], then "/user/<_id>/<email>"
+                verb: "get" | "post" | "put" | "delete";
+                dialog?: {
+                    title: string;
+                    message: string;
+                };
+            };
+        };
+    }[];
+}

package/src/interfaces/project-backend.interface.ts

@@ -0,0 +1,48 @@
+interface IDatabase {
+  provider:
+    | "mariadb"
+    | "mongodb"
+    | "oracle"
+    | "postgresql"
+    | "mysql"
+    | "sqlserver";
+  connectionString: string;
+  credentials: {
+    username: string;
+    password: string;
+    host: string;
+    databaseName: string;
+    port?: number;
+  };
+}
+
+interface IStorage {
+  provider: "gcs" | "s3" | "azure";
+  publicBucketName: string;
+  privateBucketName: string;
+  credentials: {
+    projectId: string;
+    privateKey: string;
+    clientEmail: string;
+  };
+}
+
+interface ILogging {
+  discordWebhookUrl?: string;
+}
+
+interface IEmail {
+  smtpUser?: string;
+  smtpPass?: string;
+  smtpFrom?: string;
+}
+
+export interface IBackend {
+  framework: "functions" | "lambda" | "laravel" | "nest" | "dotnet";
+  database: IDatabase;
+  jwtSecret: string;
+  baseUrl?: string;
+  storage?: IStorage;
+  logging?: ILogging;
+  email?: IEmail;
+}

package/src/interfaces/project-style.interface.ts

@@ -0,0 +1,129 @@
+/**
+ * Defines the color palette for a theme.
+ * Includes primary, secondary, tertiary, and status colors.
+ */
+interface IColorPalette {
+  primary?: string;
+  primaryContrast?: string;
+  secondary?: string;
+  secondaryContrast?: string;
+  tertiary?: string;
+  tertiaryContrast?: string;
+  quaternary?: string;
+  quaternaryContrast?: string;
+  background?: string;
+  error?: string;
+  success?: string;
+  warning?: string;
+  info?: string;
+}
+
+/**
+ * Defines typography styles for a theme.
+ */
+interface ITypography {
+  fontFamily?: string;
+  fontSize?: string;
+}
+
+/**
+ * Defines border styles for a theme.
+ */
+interface IBorders {
+  radius?: string;
+}
+
+/**
+ * Defines shadow styles for a theme.
+ */
+interface IShadows {
+  boxShadow?: string;
+}
+
+/**
+ * Defines styles for form input elements.
+ */
+interface IInputStyles {
+  background?: string;
+  text?: string;
+  border?: string;
+  borderRadius?: string;
+  focusBorder?: string;
+  placeholder?: string;
+  width?: string;
+}
+
+/**
+ * Defines styles for button elements.
+ */
+interface IButtonStyles {
+  background?: string;
+  text?: string;
+  border?: string;
+  borderRadius?: string;
+  hoverBackground?: string;
+  hoverText?: string;
+  hoverBorder?: string;
+  disabledBackground?: string;
+  disabledText?: string;
+  disabledBorder?: string;
+}
+
+/**
+ * Defines styles for label elements.
+ */
+interface ILabelStyles {
+  text?: string;
+  fontSize?: string;
+  fontWeight?: string;
+}
+
+/**
+ * Defines styles for fieldset elements.
+ */
+interface IFieldsetStyles {
+  border?: string;
+  borderRadius?: string;
+  legendText?: string;
+  legendFontSize?: string;
+  legendFontWeight?: string;
+}
+
+/**
+ * Groups all component-specific styles.
+ */
+interface IComponentStyles {
+  input?: IInputStyles;
+  button?: IButtonStyles;
+  label?: ILabelStyles;
+  fieldset?: IFieldsetStyles;
+}
+
+/**
+ * Represents a complete theme definition, combining palette, typography,
+ * and component-specific styles.
+ */
+interface ITheme {
+  colors?: IColorPalette;
+  typography?: ITypography;
+  borders?: IBorders;
+  shadows?: IShadows;
+  spacing?: string;
+  maxWidth?: string;
+  headerHeight?: string;
+  footerHeight?: string;
+  components?: IComponentStyles;
+}
+
+/**
+ * Defines the style structure for the entire project, allowing for
+ * different themes to be applied to different layout sections.
+ */
+export interface IStyle {
+  themeName: string;
+  overall?: ITheme;
+  main?: ITheme;
+  navBar?: ITheme;
+  sideBar?: ITheme;
+  footer?: ITheme;
+}

package/src/interfaces/project.interface.ts

@@ -0,0 +1,79 @@
+import type { IDataCard } from "./data-card.interface";
+import type { IDataChart } from "./data-chart.interface";
+import type { IDataDetail } from "./data-detail.interface";
+import type { IDataGrid } from "./data-grid.interface";
+import type { IDataTable } from "./data-table.interface";
+import type { IForm } from "./form.interface";
+import type { IDashboard } from "./layout-dashboard.interface";
+import type { IPanel } from "./layout-panel.interface";
+import type { IList } from "./list.interface";
+import type { IBackend } from "./project-backend.interface";
+import type { IStyle } from "./project-style.interface";
+
+export interface IProject {
+  id: string;
+  title: string;
+  description: string;
+  businessPlan?: IBusinessPLan;
+  businessRules?: IBusinessRule[];
+  flow:
+    | "autentikigo"
+    | "invito"
+    | "permeson"
+    | "komerco"
+    | "labotablo"
+    | "reto";
+  frontend?: IFrontend;
+  backend?: IBackend;
+  modules?: IModule[];
+  styles?: IStyle[];
+}
+
+interface IFrontend {
+  framework: "angular" | "flutter" | "react" | "reactnative" | "svelte" | "vue";
+  uiKit: "antdesign" | "bootstrap" | "material" | "flowbite";
+}
+
+interface IBusinessPLan {
+  businessValue: string;
+  targetMarket: string;
+  benchmarkings: string;
+  legalIssues: string;
+  ethicalIssues: string;
+  afterSales: string;
+  monetization?: string;
+}
+
+export interface IBusinessRule {
+  rule: {
+    description: string;
+    subrules?: {
+      description: string;
+    }[];
+  };
+}
+
+export interface IModule {
+  id: string;
+  title: string;
+  icon: string;
+  components: IComponent[];
+  businessRules?: IBusinessRule[];
+  todo?: ITodo[];
+}
+
+export interface ITodo {
+  title: string;
+  description: string;
+}
+
+export type IComponent =
+  | IForm
+  | IList
+  | IDataTable
+  | IDataCard
+  | IDataGrid
+  | IDataDetail
+  | IDataChart
+  | IDashboard
+  | IPanel;

package/src/interfaces/yaml-template-skeleton.interface.ts

@@ -0,0 +1,35 @@
+export interface IYamlTemplateSkeleton {
+  controller: {
+    skeleton: string;
+  },
+  template: {
+    skeleton: string;
+    rapidaReplacement1Label: string;
+    rapidaReplacement2Label: string;
+    rapidaReplacement1Placeholder: string;
+    rapidaReplacement2Placeholder: string;
+    rapidaReplacement1Tooltip: string;
+    rapidaReplacement2Tooltip: string;
+    rapidaReplacement1Autofocus: string;
+    rapidaReplacement2Autofocus: string;
+    rapidaReplacement1Disabled: string;
+    rapidaReplacement2Disabled: string;
+    rapidaReplacement1Required: string;
+    rapidaReplacement2Required: string;
+    rapidaReplacement1Unique: string;
+    rapidaReplacement2Unique: string;
+    rapidaReplacement1Maxlength: string;
+    rapidaReplacement2Maxlength: string;
+    rapidaReplacement1Minlength: string;
+    rapidaReplacement2Minlength: string;
+    rapidaReplacement1Conditions: string;
+    rapidaReplacement2Conditions: string;
+  },
+  style: {
+    skeleton: string;
+  }
+}
+
+export interface IYamlStyleSkeleton {
+  skeleton: string;
+}

package/src/schemas/backend-framework-structure.schema.json

@@ -0,0 +1,194 @@
+{
+  "$id": "framework-structure-vue.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "projectFolderCase": {
+        "type": "string",
+        "enum": ["kebab", "snake", "pascal", "camel"]
+    },
+    "controllerFileNomenclature": {
+      "type": "object",
+      "properties": {
+        "case": {
+          "type": "string",
+          "enum": ["kebab", "snake", "pascal", "camel"]
+        },
+        "keyword": {
+          "type": "string"
+        }
+      },
+      "required": ["case"]
+    },
+    "modelFileNomenclature": {
+      "type": "object",
+      "properties": {
+        "case": {
+          "type": "string",
+          "enum": ["kebab", "snake", "pascal", "camel"]
+        },
+        "keyword": {
+          "type": "string"
+        }
+      },
+      "required": ["case"]
+    },
+    "moduleFileNomenclature": {
+      "type": "object",
+      "properties": {
+        "case": {
+          "type": "string",
+          "enum": ["kebab", "snake", "pascal", "camel"]
+        },
+        "keyword": {
+          "type": "string"
+        }
+      },
+      "required": ["case"]
+    },
+    "repositoryFileNomenclature": {
+      "type": "object",
+      "properties": {
+        "case": {
+          "type": "string",
+          "enum": ["kebab", "snake", "pascal", "camel"]
+        },
+        "keyword": {
+          "type": "string"
+        }
+      },
+      "required": ["case"]
+    },
+    "componentPath": {
+      "type": "string"
+    },
+    "controllerPath": {
+      "type": "string"
+    },
+    "modelPath": {
+      "type": "string"
+    },
+    "modulePath": {
+      "type": "string"
+    },
+    "repositoryPath": {
+      "type": "string"
+    },
+    "controllerFile": {
+      "type": "object",
+      "properties": {
+        "hasControllerFile": {
+          "type": "boolean"
+        },
+        "controllerFileExtension": {
+          "type": "string"
+        }
+      },
+      "required": ["hasControllerFile"]
+    },
+    "modelFile": {
+      "type": "object",
+      "properties": {
+        "hasModelFile": {
+          "type": "boolean"
+        },
+        "modelFileExtension": {
+          "type": "string"
+        }
+      },
+      "required": ["hasModelFile"]
+    },
+    "moduleFile": {
+      "type": "object",
+      "properties": {
+        "hasModuleFile": {
+          "type": "boolean"
+        },
+        "moduleFileExtension": {
+          "type": "string"
+        }
+      },
+      "required": ["hasModuleFile"]
+    },
+    "repositoryFile": {
+      "type": "object",
+      "properties": {
+        "hasRepositoryFile": {
+          "type": "boolean"
+        },
+        "repositoryFileExtension": {
+          "type": "string"
+        }
+      },
+      "required": ["hasRepositoryFile"]
+    },
+    "uniqueFile": {
+      "type": "object",
+      "properties": {
+        "hasUniqueFile": {
+          "type": "boolean"
+        },
+        "uniqueFileExtension": {
+          "type": "string"
+        }
+      },
+      "required": ["hasUniqueFile"]
+    },
+    "sourcePath": {
+      "type": "string",
+      "description": "The source path of the framework"
+    },
+    "hasComponentSpecificFolder": {
+      "type": "boolean"
+    },
+    "dependencies": {
+      "type": "object",
+      "description": "Dependencies according to components elements",
+      "properties": {
+        "array": {
+          "type": "array",
+          "elements": [
+            {
+              "type": "string",
+              "description": "Package name"
+            }
+          ]
+        },
+        "autocomplete": {
+          "type": "array",
+          "elements": [
+            {
+              "type": "string",
+              "description": "Package name"
+            }
+          ]
+        },
+        "wysiwyg": {
+          "type": "array",
+          "elements": [
+            {
+              "type": "string",
+              "description": "Package name"
+            }
+          ]
+        }
+      }
+    }
+  },
+  "required": [
+    "projectFolderCase",
+    "controllerFileNomenclature",
+    "modelFileNomenclature",
+    "moduleFileNomenclature",
+    "repositoryFileNomenclature",
+    "componentPath",
+    "controllerPath",
+    "modelFile",
+    "moduleFile",
+    "repositoryFile",
+    "uniqueFile",
+    "sourcePath",
+    "hasComponentSpecificFolder",
+    "dependencies"
+  ]
+}