@uxland/primary-shell 2.0.0 → 2.0.1-rc.0

package/README.md

@@ -1,231 +1 @@
-# 🧱🩺Primaria Shell
-Primaria Shell is the `main container` of the Primaria application. Within it, we can find the different regions where plugins can inject their views.
-
-Each plugin is provided with an "API" of type `PrimariaApi`. The plugin must use this object to interact with the shell (register views, open modals, send events, share data, query data, etc.).
-
-```
-export interface PrimariaApi extends HarmonixApi {
-  httpClient: PrimariaHttpClient;
-  interactionManager: PrimariaInteractionManager;
-  broker: PrimariaBroker;
-  regionManager: PrimariaRegionManager;
-  globalStateManager: PrimariaGlobalStateManager;
-  pluginInfo: PluginInfo;
-  createLocaleManager(messages: LocalizationMessages): Promise<HarmonixLocaleApi>;
-}
-```
-
-## 🔹 pluginInfo
-
-This property is an object containing information about the plugin (identifier).
-```
-export interface PluginInfo {
-    pluginId: string;
-}
-```
-## 🔹 httpClient
-
-TODO
-## 🔹 interactionManager
-
-This object is used to open modals and notification toasts.
-
-```
-export interface PrimariaInteractionManager {
-  notify(options: NotifyOptions): Promise<any>;
-  doConfirm(options: ConfirmOptions): Promise<boolean>;
-  doCustomConfirm(options: CustomConfirmOptions): Promise<boolean>;
-}
-```
-
-### ▪notify
-
-Function to display a notification toast. You need to pass options as an argument.
-
-```
-export interface NotifyOptions {
-  message?: string;
-  type?: NotifyType;
-  position?: NotifyPosition;
-  order?: string;
-}
-
-export type NotifyOrder = "first" | "second" | "third" | "fourth" | "fifth";
-export type NotifyPosition = "bottom" | "center" | "top";
-export type NotifyType = "danger" | "warning" | "info" | "success";
-```
-Example:
-```
- api.interactionManager.notify({
-    message: "Esta es un Toast de notificación!!",
-    type: "danger",
-  });
-```
-
-### ▪doConfirm
-
-Function to display a basic confirmation modal. You need to pass options as an argument.
-
-```
-export interface ConfirmOptions {
-  title: string;
-  message: string;
-  type: ConfirmType;
-  acceptLabel: string;
-  cancelLabel: string;
-}
-```
-Example:
-
-```
- api.interactionManager
-    .doConfirm({
-      title: "Confirmation title",
-      type: "info",
-      message: "Això és missatge de confirmacio",
-      acceptLabel: "Acceptar",
-      cancelLabel: "Cancelar",
-    })
-    .then((r) => console.log(r));
-```
-
-### ▪doCustomConfirm
-
-Function to display a customized confirmation modal. You need to pass options as an argument, including a component constructor to be rendered inside the modal.
-
-```
-export interface CustomConfirmOptions<T = any> {
-  title: string;
-  componentConstructor: Constructor<LitElement | any>;
-  type: ConfirmType;
-  acceptLabel?: string;
-  cancelLabel?: string;
-  model?: T;
-}
-```
-
-Example:
-
-```
-  api.interactionManager
-    .doCustomConfirm({
-      title: "Confirmation title",
-      type: "danger",
-      componentConstructor: TitleView,
-      acceptLabel: "Acceptar",
-      cancelLabel: "Cancelar",
-      properties: { title: "HOLAAA" },
-    })
-    .then((r) => console.log(r));
-```
-## 🔹 regionManager
-
-This object is used to manage views within regions (injection, activation, deactivation, etc.).
-
-```
-export interface PrimariaRegionManager extends HarmonixRegionManager {
-  registerMenu(view: HarmonixViewDefinition): Promise<void>;
-  registerQuickAction(view: HarmonixViewDefinition): Promise<void>;
-  registerMainView(view: HarmonixViewDefinition, title: string): Promise<void>;
-  activateMainView(viewId: string): Promise<void>;
-}
-```
-
-The Primaria API defines these functions to help easily register views in the main shell regions, although you can also use the original Harmonix framework API with all its facilities.
-
-```
-export interface HarmonixRegionManager {
-    registerView(regionName: string, view: HarmonixViewDefinition): Promise<void>;
-    removeView(regionName: string, viewId: string): Promise<void>;
-    activateView(regionName: string, viewId: string): Promise<void>;
-    deactivateView(regionName: string, viewId: string): Promise<void>;
-    getRegion(regionName: string): Promise<IRegion>;
-    isViewActive(regionName: string, viewId: string): Promise<boolean>;
-    containsView(regionName: string, viewId: string): Promise<boolean>;
-}
-```
-
-Example:
-
-```
-api.regionManager.registerMainView(
-    {
-      id: "my-plugin",
-      factory: () => new MainComponent(),
-    },
-    "My Plugin title",
-  );
-```
-## 🔹 createLocaleManager
-
-This function receives a collection of translations and returns an object capable of translating and obtaining the current language.
-
-```
-export interface HarmonixLocaleApi {
-    getCurrentLanguage(): string;
-    translate<T = Record<string, string>>(path: string, variables?: T): string;
-    getTranslations(): LocalizationMessages;
-}
-```
-
-Example: 
-
-```
-  const pluginLocaleManager = api.createLocaleManager(locales);
-  console.log(pluginLocaleManager.getTranslations());
-  console.log(pluginLocaleManager.translate("title"));
-```
-
-## 🔹 globalStateManager
-
-This object provides the capability to set or get global data. It is used to share data between plugins or to obtain important data that the core of the application may provide.
-
-```
-export abstract class PrimariaGlobalStateManager {
-  abstract setData(key: string, value: any): void;
-  abstract getData(key: string): any;
-  abstract clearData(): void;
-}
-```
-
-Example: 
-
-```
-    api.globalStateManager.setData("key1", "value1");
-    const result = globalStateManager.getData("key1");
-    console.log("key1"); // "value1"
-```
-
-## 🔹 broker
-
-This object provides a way to handle messaging through an internal broker or bus. Plugins can use this bus to communicate with other plugins, but also to manage internal plugin messaging, delegating all responsibility to the broker by registering handlers for each use case, adhering to architectural patterns and clean code practices.
-
-
-```
-export interface PrimariaBroker {
-    send<TRequest extends IRequest<TResponse>, TResponse>(message: TRequest): Promise<TResponse>;
-    send<TPayload, TResponse>(requestName: string, payload: TPayload): Promise<TResponse>;
-    publish<TEvent extends IEvent>(event: TEvent): Promise<void>;
-    publish<TPayload>(eventName: string, payload: TPayload): Promise<void>;
-    subscribe<TEvent extends IEvent>(event: IEventClass, handler: EventHandler<TEvent>): void;
-    subscribe<TPayload>(eventName: string, handler: EventHandler<TPayload>): void;
-    registerRequest<TRequest extends IRequest<TResponse>, TResponse>(request: IRequestClass<TRequest>, handler: RequestHandler<TRequest, TResponse>): void;
-    registerRequest<TPayload, TResponse>(requestName: string, handler: RequestHandler<TPayload, TResponse>): void;
-}
-```
-
-All methods can be used by message name (request) or by class. It is recommended that plugins register messages and use the broker with a prefix to avoid collisions between plugins, such as registering the same message.
-
-Example: 
-
-```
-
-class Greet implements IRequest<string> {
-  constructor(public message: string) {}
-}
-api.broker.registerRequest(command: Greet, (cmd: IRequest<any>) => {
-    alert(command.message)
-});
-
-api.broker.send(new Greet("Jaaaa")); //This will alert "Jaaaa"
-```
+Full Harmonix and Primaria Shell Documentation here: https://doc.clickup.com/9012015559/d/h/8cjgwe7-2192/bc9e680ac3c7b52