@kumori/aurora-interfaces 1.0.22 → 1.0.24

package/enums/callToActionEnum.ts

@@ -0,0 +1,200 @@
+import { ROUTE_NAMES } from "./routesEnum";
+import { buttonAction, CallToActionNotification, Notification } from "../interfaces/notification-interface";
+
+interface callToAction {
+  type: string;
+  criticality: "critical" | "high" | "low";
+  support?: boolean;
+  noActions?: boolean;
+  actions?: buttonAction[];
+}
+
+// La idea es tener aqui la definicion de todas las notificaciones call to action y que el userContext consulte esta definicion al recibir una notificacion normal,
+// si el type de la notificacion recibida coincide con el type de algun CallToAction se creara una CallToActionNotification y se añadira a la lista de notificaciones callToActiondel usuario.
+// Esto permite que el front pueda mostrar notificaciones call to action sin necesidad de que el backend las envie,
+// simplemente con que el backend envie una notificacion normal con un type que coincida con alguno de los definidos aqui, el userContext creara la CallToActionNotification y el front la mostrara al usuario.
+//
+// De esta forma tenemos aqui una definicion desacoplada de todas las notificaciones call to action que queremos mostrar al usuario,
+// el backend solo tiene que enviar notificaciones normales con un type que coincida con alguno de los de esta definicion para que el front las muestre como call to action.
+//
+// El front usará la route para redirigir al usuario a la pagina correspondiente cuando haga click en el boton de la notificacion call to action.
+//
+// Se expone como un Map (type -> callToAction) en lugar de un array porque el userContext necesita comprobar el type
+// de cada notificacion que recibe, y con un array habria que recorrerlo entero (find/some) cada vez, es decir O(n) por notificacion.
+// Con un Map la busqueda por type es O(1), y el coste de construirlo (recorrer las entradas una sola vez) se paga una unica vez al cargar el modulo.
+// Los "type" de aqui abajo coinciden con los "subtype" definidos en errorsEnum.ts: el backend envia una
+// notificacion normal cuyo type es ese identificador (p.ej. "tenant-deletion-error") y, si coincide con
+// una de estas entradas, el userContext genera la CallToActionNotification correspondiente.
+const callToActionDefinitions: callToAction[] = [
+  {
+    type: "tenant-creation-error",
+    criticality: "high",
+    support: true,
+    actions: [
+      { label: "Retry", buttonType: "primary", icon: "refresh", route: ROUTE_NAMES.CREATE_TENANT },
+      { label: "Contact support", buttonType: "text", route: ROUTE_NAMES.USER_INFO },
+    ],
+  },
+  {
+    type: "tenant-deletion-error",
+    criticality: "high",
+    support: true,
+    actions: [
+      { label: "Retry deletion", buttonType: "primary", icon: "delete", route: ROUTE_NAMES.TENANTS },
+    ],
+  },
+  {
+    type: "tenant-user-invite-error",
+    criticality: "low",
+    actions: [
+      { label: "Retry invite", buttonType: "secondary", route: ROUTE_NAMES.TENANTS },
+    ],
+  },
+  {
+    type: "account-creation-error",
+    criticality: "high",
+    support: true,
+    actions: [
+      { label: "Retry", buttonType: "primary", icon: "refresh", route: ROUTE_NAMES.CREATE_ACCOUNT },
+    ],
+  },
+  {
+    type: "account-deletion-error",
+    criticality: "high",
+    support: true,
+    actions: [
+      { label: "Retry", buttonType: "primary", icon: "delete", route: ROUTE_NAMES.ACCOUNTS },
+    ],
+  },
+  {
+    type: "account-clean-error",
+    criticality: "low",
+    actions: [
+      { label: "View account", buttonType: "text", route: ROUTE_NAMES.ACCOUNTS },
+    ],
+  },
+  {
+    type: "environment-creation-error",
+    criticality: "high",
+    support: true,
+    actions: [
+      { label: "Retry", buttonType: "primary", icon: "refresh", route: ROUTE_NAMES.CREATE_ENVIRONMENT },
+    ],
+  },
+  {
+    type: "environment-deletion-error",
+    criticality: "high",
+    support: true,
+    actions: [
+      { label: "Retry", buttonType: "primary", icon: "delete", route: ROUTE_NAMES.ENVIRONMENTS },
+    ],
+  },
+  {
+    type: "environment-scale-error",
+    criticality: "low",
+    actions: [
+      { label: "View environment", buttonType: "text", route: ROUTE_NAMES.ENVIRONMENTS },
+    ],
+  },
+  {
+    type: "deployment-error",
+    criticality: "critical",
+    support: true,
+    actions: [
+      { label: "Retry deployment", buttonType: "primary", icon: "refresh", route: ROUTE_NAMES.DEPLOY_SERVICE },
+      { label: "View logs", buttonType: "text", route: ROUTE_NAMES.OBSERVABILITY },
+    ],
+  },
+  {
+    type: "error-instance-update",
+    criticality: "critical",
+    support: true,
+    actions: [
+      { label: "Retry", buttonType: "primary", icon: "refresh", route: ROUTE_NAMES.RUNTIME },
+    ],
+  },
+  {
+    type: "error-service-link",
+    criticality: "high",
+    actions: [
+      { label: "Retry link", buttonType: "primary", route: ROUTE_NAMES.LINK_SERVICES },
+    ],
+  },
+  {
+    type: "resource-creation-error",
+    criticality: "high",
+    support: true,
+    actions: [
+      { label: "Retry", buttonType: "primary", icon: "refresh", route: ROUTE_NAMES.CREATE_RESOURCE },
+    ],
+  },
+  {
+    type: "resource-deletion-error",
+    criticality: "high",
+    support: true,
+    actions: [
+      { label: "Retry", buttonType: "primary", icon: "delete", route: ROUTE_NAMES.RESOURCES },
+    ],
+  },
+  {
+    type: "user-delete-error",
+    criticality: "critical",
+    support: true,
+    actions: [
+      { label: "Contact support", buttonType: "primary", route: ROUTE_NAMES.USER_INFO },
+    ],
+  },
+  // No todos los call to action son errores: tambien sirven para destacar notificaciones "normales"
+  // (exitos) que conviene que el usuario pueda abrir con un click.
+  {
+    type: "tenant-created",
+    criticality: "low",
+    actions: [
+      { label: "View tenant", buttonType: "text", route: ROUTE_NAMES.TENANTS },
+    ],
+  },
+  {
+    type: "account-created",
+    criticality: "low",
+    actions: [
+      { label: "View account", buttonType: "text", route: ROUTE_NAMES.ACCOUNTS },
+    ],
+  },
+  {
+    type: "deployment-success",
+    criticality: "low",
+    actions: [
+      { label: "View service", buttonType: "text", route: ROUTE_NAMES.SERVICE_DETAIL },
+    ],
+  },
+  {
+    // Caso limite a proposito: solo informa (noActions), sin actions. Sirve para probar
+    // createCallToActionNotification cuando cta.actions es undefined.
+    type: "plan-upgrade",
+    criticality: "low",
+    noActions: true,
+  },
+];
+
+const CallToActionMap: Map<string, callToAction> = new Map(
+  callToActionDefinitions.map((cta) => [cta.type, cta])
+);
+
+// Helper para que el userContext no pueda modificar el map de ninguna forma, solo acceder a su información.
+export function getCallToActionByType(type: string): callToAction | undefined {
+  return CallToActionMap.get(type);
+}
+
+export function createCallToActionNotification(
+  notification: Notification,
+  cta: callToAction
+): CallToActionNotification {
+  return {
+    ...notification,
+    notificationType: 'callToAction',
+    criticality: cta.criticality,
+    support: cta.support,
+    noActions: cta.noActions,
+    actions: cta.actions,
+  };
+}

package/enums/routesEnum.ts

@@ -0,0 +1,23 @@
+export enum ROUTE_NAMES  {
+  HOME = "home",
+  TENANTS = "tenants",
+  ACCOUNTS = "accounts",
+  ENVIRONMENTS = "environments",
+  RUNTIME = "runtime",
+  RESOURCES = "resources",
+  DEPLOY = "deploy",
+  USER_INFO = "me",
+  CREATE_TENANT = "create-tenant",
+  DEPLOY_SERVICE = "deploy-service",
+  DEPLOY_MARKETPLACE = "deploy-marketplace",
+  CREATE_ACCOUNT = "create-account",
+  CREATE_ENVIRONMENT = "create-environment",
+  CREATE_ORGANIZATION = "create-organization",
+  SERVICE_DETAIL = "service-detail",
+  CREATE_APPLICATION = "create-application",
+  LINK_SERVICES = "link-services",
+  CREATE_RESOURCE = "create-resource",
+  REGISTER = "register",
+  OBSERVABILITY = "observability",
+  CREATE_RESOURCE_STANDALONE = "create-resource-standalone",
+};

package/interfaces/notification-interface.ts

@@ -1,24 +1,41 @@
-export interface Notification{
-    type: string;
-    subtype: string;
-    info_content?: {
-        code: string;
-        message: string;
-        timestamp?: string;
-    }
-    date: string;
-    data?: any;
-    status: 'read' | 'unread';
-    callToAction: boolean;
-    userError?: boolean;
-}
+import { ROUTE_NAMES } from "../enums/routesEnum";
 
-export interface FormattedNotification extends Notification{
-    title: string;
-    description: string;
-    icon: string;
-    color: string;
-    actions?: { label: string; color: string; action: () => void }[];
-    presentationType: "toast" | "popup";
+export interface Notification {
+  type: string;
+  subtype: string;
+  info_content?: {
+    code: string;
+    message: string;
+    timestamp?: string;
+  };
+  date: string;
+  data?: any;
+  status: "read" | "unread";
+  notificationType: 'regular' | 'callToAction'; // Cambiar por type
+  userError?: boolean;
+}
+export interface buttonAction {
+  label: string;
+  buttonType: string;
+  outlined?: boolean;
+  icon?: string;
+  iconColor?: string;
+  route: ROUTE_NAMES;
+}
+export interface CallToActionNotification extends Notification {
+  notificationType: 'callToAction';
+  criticality: "critical" | "high" | "low";
+  support?: boolean;
+  noActions?: boolean;
+  actions?: buttonAction[];
+  // Cambiar por array actions y tiprarlo.
+}
 
-}
+export interface FormattedNotification extends Notification {
+  title: string;
+  description: string;
+  icon: string;
+  color: string;
+  actions?: { label: string; color: string; action: () => void }[];
+  presentationType: "toast" | "popup";
+}

package/interfaces/user-interface.ts

@@ -1,4 +1,4 @@
-import { Notification } from "./notification-interface";
+import { CallToActionNotification, Notification } from "./notification-interface";
 import { Plan } from "./plan-interface";
 import { Token } from "./token-interface";
 import { Tenant } from "./tenant-interface";
@@ -52,6 +52,7 @@ export interface UserData {
   platform?: Platform;
   status?: "logged" | "notlogged" | "maintenance" | "unknown";
   notifications?: Notification[];
+  callToActionNotifications?: CallToActionNotification[];
   plans?: Plan[];
   discoveryMethod?: string;
 }
@@ -76,6 +77,7 @@ export class User implements UserData {
     this.platform = platform ?? userData.platform;
     this.status = userData.status || "logged";
     this.notifications = userData.notifications || [];
+    this.callToActionNotifications = userData.callToActionNotifications || [];
     this.plans = userData.plans || [];
     this.provider = userData.provider;
 	this.discoveryMethod = userData.discoveryMethod;
@@ -99,6 +101,7 @@ export class User implements UserData {
   platform?: Platform;
   status?: "logged" | "notlogged" | "maintenance" | "unknown";
   notifications?: Notification[];
+  callToActionNotifications?: CallToActionNotification[];
   plans?: Plan[];
   discoveryMethod?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kumori/aurora-interfaces",
-  "version": "1.0.22",
+  "version": "1.0.24",
   "description": "aurora interfaces",
   "main": "export-interfaces.ts",
   "repository": {