@luigi-project/container 1.2.0-rc2 → 1.2.0-rc4

package/constants/event-type.d.ts

@@ -0,0 +1,25 @@
+// TODO: Add and extend event to inclide custom typings/interface to make it easier to use on the listener parameter
+export interface ParamsEvent extends Event {}
+
+/**
+ * PathExistsEvent interface is used to make it easier to use the `linkManager().pathExists()` promise based function
+ * on the core application side.
+ * 
+ * It enforces the use of the callback function, since the latter is hardcoded to be **'callback'**. 
+ * This allows to send back the boolean value if the path exists or not.
+ * @Example
+ * ```
+ * addEventListener(Events.PATH_EXISTS_REQUEST, event: PathExistsEvent => {
+ *      event.callback(true);
+ *   }
+ * };
+ * ```
+ */
+export interface PathExistsEvent extends Event {
+    /**
+     * 
+     * @param value the boolean value that is to be sent back to the the path exists promise i.e.: `linkManager().pathExists().then(value...) 
+     * @returns void
+     */
+    callback: (value: boolean) => void; 
+}

package/constants/events.d.ts

@@ -1,97 +1,151 @@
 export namespace Events {
   /**
-   * A message emmitted from the Microfrontend when a custom message is sent
+   * A message emitted from the micro frontend when a custom message is sent
    */
   export const CUSTOM_MESSAGE = 'custom-message';
   /**
-   * A message emmitted from the Microfrontend when the context data is sent
+   * A message emitted from the micro frontend when the context data is sent
    */
   export const GET_CONTEXT_REQUEST = 'get-context-request';
   /**
-   * A message emmitted from the Microfrontend when a navigation request is sent
+   * A message emitted from the micro frontend when a navigation request is sent
    */
   export const NAVIGATION_REQUEST = 'navigation-request';
   /**
-   * A message emmitted from the Microfrontend when a request to show an alert is sent
+   * A message emitted from the micro frontend when a request to show an alert is sent
    */
   export const ALERT_REQUEST = 'show-alert-request';
   /**
-   * A message emmitted from the Microfrontend when it is first initialized
+   * A message emitted from the micro frontend when a request to show an alert is sent
+   */
+  export const ALERT_CLOSED = 'close-alert-request';
+  /**
+   * A message emitted from the micro frontend when it is first initialized
    */
   export const INITIALIZED = 'initialized';
   /**
-   * A message emmitted from the Microfrontend to request adding search parameters to the URL
+   * A message emitted from the micro frontend to request adding search parameters to the URL
    */
   export const ADD_SEARCH_PARAMS_REQUEST = 'add-search-params-request';
   /**
-   * A message emmitted from the Microfrontend to request adding node parameters to the URL
+   * A message emitted from the micro frontend to request adding node parameters to the URL
    */
   export const ADD_NODE_PARAMS_REQUEST = 'add-node-params-request';
   /**
-   * A message emmitted from the Microfrontend when a request to show an confirmation modal is sent
+   * A message emitted from the micro frontend when a request to show a confirmation modal is sent
    */
   export const SHOW_CONFIRMATION_MODAL_REQUEST = 'show-confirmation-modal-request';
   /**
-   * A message emmitted from the Microfrontend when a request to show loading indicator is sent
+   * A message emitted from the micro frontend when a request to show a loading indicator is sent
    */
   export const SHOW_LOADING_INDICATOR_REQUEST = 'show-loading-indicator-request';
   /**
-   * A message emmitted from the Microfrontend when a request to hide the loading indicator is sent
+   * A message emitted from the micro frontend when a request to hide the loading indicator is sent
    */
   export const HIDE_LOADING_INDICATOR_REQUEST = 'hide-loading-indicator-request';
 
   /**
-   * A message emmitted from the Microfrontend when a request to set the current locale is sent
+   * A message emitted from the micro frontend when a request to set the current locale is sent
    */
   export const SET_CURRENT_LOCALE_REQUEST = 'set-current-locale-request';
 
   /**
-   * A message emmitted from the Microfrontend when a request to modify the local storage is sent
+   * A message emitted from the micro frontend when a request to modify the local storage is sent
    */
   export const LOCAL_STORAGE_SET_REQUEST = 'set-storage-request';
 
   /**
-   * A message emmitted from the Microfrontend when a request to handle an error that happened during the runtime on the microfrontend is sent
+   * A message emitted from the micro frontend when a request to handle an error that happened during the runtime of the micro frontend is sent
    */
   export const RUNTIME_ERROR_HANDLING_REQUEST = 'runtime-error-handling-request';
 
   /**
-   * A message emmitted from the Microfrontend when a request to set the anchor of the URL is sent
+   * A message emitted from the micro frontend when a request to set the anchor of the URL is sent
    */
   export const SET_ANCHOR_LINK_REQUEST = 'set-anchor-request';
 
   /**
-   * A message emmitted from the Microfrontend when a request to set third party cookies is sent
+   * A message emitted from the micro frontend when a request to set third-party cookies is sent
    */
   export const SET_THIRD_PARTY_COOKIES_REQUEST = 'set-third-party-cookies-request';
 
   /**
-   * A message emmitted from the Microfrontend when a request to navigate back is sent
+   * A message emitted from the micro frontend when a request to navigate back is sent
    */
   export const BACK_NAVIGATION_REQUEST = 'navigate-back-request';
 
   /**
-   * A message emmitted from the Microfrontend when a request to receive the current app route is sent
+   * A message emitted from the micro frontend when a request to receive the current app route is sent
    */
   export const GET_CURRENT_ROUTE_REQUEST = 'get-current-route-request';
 
   /**
-   * A message emmitted from the Microfrontend to report that the navigation is completed is sent
+   * A message emitted from the micro frontend to report that the navigation is completed is sent
    */
   export const NAVIGATION_COMPLETED_REPORT = 'report-navigation-completed-request';
 
   /**
-   * A message emmitted from the Microfrontend when a request to update the modal path parameters is sent
+   * A message emitted from the micro frontend when a request to update the modal path parameters is sent
    */
   export const UPDATE_MODAL_PATH_DATA_REQUEST = 'update-modal-path-data-request';
 
   /**
-   * A message emmitted from the Microfrontend when a request to check on the validity of a path is sent
+   * A message emitted from the micro frontend when a request to check on the validity of a path is sent
    */
   export const CHECK_PATH_EXISTS_REQUEST = 'check-path-exists-request';
 
   /**
-   * A message emmitted from the Microfrontend when a request to set the 'dirty status' (ex: avoid closing if usaved changes) is sent
+   * A message emitted from the micro frontend when a request to set the 'dirty status' (eg: avoid closing if unsaved changes) is sent
    */
   export const SET_DIRTY_STATUS_REQUEST = 'set-dirty-status-request';
+
+  /**
+   * A message emitted from the micro frontend when a request to set the view group data
+   */
+  export const SET_VIEW_GROUP_DATA_REQUEST = 'set-viewgroup-data-request';
+
+  /**
+   * A message emitted from the micro frontend when a request to set the document title
+   */
+  export const SET_DOCUMENT_TITLE_REQUEST = 'set-document-title-request';
+
+  /**
+   * A message emitted from the micro frontend when a request to open user settings
+   */
+  export const OPEN_USER_SETTINGS_REQUEST = 'open-user-settings-request';
+
+  /**
+   * A message emitted from the micro frontend when a request to close user settings
+   */
+  export const CLOSE_USER_SETTINGS_REQUEST = 'close-user-settings-request';
+
+  /**
+   * A message emitted from the micro frontend when a request to collapse left side navigation
+   */
+  export const COLLAPSE_LEFT_NAV_REQUEST = 'collapse-leftnav-request';
+
+  /**
+   * A message emitted from the micro frontend when a request to remove the backdrop
+   */
+  export const UPDATE_TOP_NAVIGATION_REQUEST = 'update-top-navigation-request';
+
+  /**
+   * A message emitted from the micro frontend when a request to remove the backdrop
+   */
+  export const PATH_EXISTS_REQUEST = 'path-exists-request';
+
+  /**
+   * A message emitted from the micro frontend when a request to remove the backdrop
+   */
+  export const GO_BACK_REQUEST = 'go-back-request';
+
+  /**
+   * A message emitted from the micro frontend when a request to remove the backdrop
+   */
+  export const HAS_BACK_REQUEST = 'has-back-request';
+
+  /**
+   * A message emitted from the micro frontend when a request to remove the backdrop
+   */
+  export const REMOVE_BACKDROP_REQUEST = 'remove-backdrop-request';
 }

package/index.d.ts

@@ -2,3 +2,4 @@ export { default as LuigiContainer } from './LuigiContainer.svelte';
 export { default as LuigiCompoundContainer } from './LuigiCompoundContainer.svelte';
 import { Events } from './constants/events';
 export default Events;
+export type { PathExistsEvent } from './constants/event-type';

package/package.json

@@ -19,5 +19,5 @@
         "micro-frontends",
         "microfrontends"
     ],
-    "version": "1.2.0-rc2"
+    "version": "1.2.0-rc4"
 }