@akinon/app-shared 0.2.0 → 0.2.2

package/dist/types.d.ts

@@ -1,47 +1,120 @@
+/**
+ * Represents the type of a registered application within the system.
+ * @typedef {('fullpage' | 'plugin')} RegisteredAppType
+ */
 export type RegisteredAppType = 'fullpage' | 'plugin';
+/**
+ * Defines the structure of a registered application, including its type,
+ * unique identifier, URL, and slug.
+ * @typedef {Object} RegisteredApp
+ * @property {number} id - The unique identifier of the application.
+ * @property {string} url - The URL where the application is hosted.
+ * @property {string} slug - A short, unique string used to identify the application.
+ * @property {RegisteredAppType} type - The type of the application (e.g., 'fullpage' or 'plugin').
+ */
 export type RegisteredApp = {
     id: number;
     url: string;
     slug: string;
     type: RegisteredAppType;
 };
+/**
+ * Describes a page within an application, including its navigation path and label.
+ * @typedef {Object} Page
+ * @property {string} path - The navigation path of the page.
+ * @property {string} label - The label used for displaying the page in menus or navigation elements.
+ */
 export type Page = {
     path: string;
     label: string;
 };
-export interface AppClientConfig {
+/**
+ * Common configuration settings for applications, which may include options for
+ * development mode, redirection behavior, and menu structure. This base configuration
+ * is applicable to both full-page and plugin applications.
+ *
+ * @typedef {Object} ApplicationConfig
+ * @property {boolean} [isDev=false] - Indicates if the application is running in development mode. This can
+ *                                      enable more verbose logging or debugging features.
+ * @property {boolean} [forceRedirect=false] - Indicates if the application should force a redirect into an
+ *                                             iframe context, enhancing security and encapsulation.
+ */
+export interface ApplicationConfig {
     isDev?: boolean;
     forceRedirect?: boolean;
+}
+/**
+ * Configuration settings for full-page applications, extending the common `ApplicationConfig`.
+ * Full-page applications typically occupy the entire viewport and may have a menu for
+ * navigation.
+ *
+ * Inherits all properties from `ApplicationConfig` with no additional specific properties, but
+ * explicitly restates `menu` to emphasize its relevance to full-page applications.
+ *
+ * @typedef {Object} FullpageApplicationConfig
+ * @extends ApplicationConfig
+ * @property {Page[]} [menu] - Optionally redefined from `ApplicationConfig` to highlight its
+ *                             importance in full-page applications for defining the navigation menu.
+ */
+export interface FullpageApplicationConfig extends ApplicationConfig {
     menu?: Page[];
 }
-export type AppConfig = {
-    /** Authentication token. */
-    token: string | null;
-    language: string;
-};
-export interface ApplicationData {
-    [key: string]: any;
+/**
+ * Configuration settings for plugin applications, which are smaller applications or widgets
+ * embedded within a larger application context. Extends the common `ApplicationConfig` with
+ * an additional property specific to plugins.
+ *
+ * Plugin applications are designed to be embedded and might require a specific placeholder
+ * within the DOM where they can be loaded.
+ *
+ * @typedef {Object} PluginApplicationConfig
+ * @extends ApplicationConfig
+ * @property {string} placeholderId - The ID of the DOM element where the plugin application
+ *                                    should be rendered. This allows the application to be
+ *                                    dynamically inserted into the correct location within
+ *                                    the host environment.
+ */
+export interface PluginApplicationConfig extends ApplicationConfig {
+    placeholderId: string;
 }
-export type CustomDataEvent = {
+/**
+ * A flexible data structure for storing application data, with string keys and any type of value.
+ * @typedef {Object} ApplicationData
+ */
+export interface ApplicationData {
     [key: string]: any;
-};
-export interface ParentModel {
-    appConfig: AppConfig;
-}
-export interface ChildModel {
-    pages: Page[];
 }
-export interface HandshakeEmitMap {
-    navigateViaChild: {
-        path: string;
-        label?: string;
+/**
+ * Defines actions that can be shared across applications, including default UI actions and custom actions.
+ * @typedef {Object} ApplicationActions
+ * @property {Function} [showModalDialog] - Optional. A function to show a modal dialog.
+ * @property {Function} [showConfirmationDialog] - Optional. A function to show a confirmation dialog.
+ * @property {Function} [showToast] - Optional. A function to show a toast message.
+ * @property {Function} [showErrorMessage] - Optional. A function to display an error message.
+ * @property {Object} actions - A collection of custom actions that can be invoked.
+ */
+export interface ApplicationActions {
+    showModalDialog?: (title: string, content: string) => void;
+    showConfirmationDialog?: (title: string, content: string) => boolean;
+    showToast?: (content: string, type: 'success' | 'warning' | 'error' | 'loading' | 'destroy') => void;
+    showErrorMessage?: (title: string, content: string) => void;
+    actions: {
+        [key: string]: (...args: any[]) => any;
     };
-    customData: CustomDataEvent;
 }
-export interface HandshakeCallMap {
-    navigateViaParent: {
-        path: string;
-    };
-    receiveCustomData: CustomDataEvent;
+/**
+ * Provides a mechanism for navigating within the application.
+ * @typedef {Object} ApplicationNavigation
+ * @property {Function} navigate - A function that performs navigation to the specified URL.
+ */
+export interface ApplicationNavigation {
+    navigate: (url: string) => void;
 }
+/**
+ * Represents a custom event with flexible data structure for storing event-specific data.
+ * @typedef {Object} CustomDataEvent
+ */
+export type CustomDataEvent = {
+    [key: string]: any;
+};
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,iBAAiB,GAAG,UAAU,GAAG,QAAQ,CAAC;AAEtD,MAAM,MAAM,aAAa,GAAG;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,iBAAiB,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,WAAW,eAAe;IAC9B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC;CACf;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,4BAA4B;IAC5B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,WAAW,eAAe;IAE9B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAGD,MAAM,MAAM,eAAe,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAAC;AAErD,MAAM,WAAW,WAAW;IAC1B,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AAED,MAAM,WAAW,gBAAgB;IAC/B,gBAAgB,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACnD,UAAU,EAAE,eAAe,CAAC;CAC7B;AAED,MAAM,WAAW,gBAAgB;IAC/B,iBAAiB,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACpC,iBAAiB,EAAE,eAAe,CAAC;CACpC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,UAAU,GAAG,QAAQ,CAAC;AAEtD;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,iBAAiB,CAAC;CACzB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;IAClE,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC;CACf;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,uBAAwB,SAAQ,iBAAiB;IAChE,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAE9B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,kBAAkB;IAEjC,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAC3D,sBAAsB,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC;IACrE,SAAS,CAAC,EAAE,CACV,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,KAC1D,IAAI,CAAC;IACV,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAE5D,OAAO,EAAE;QAGP,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;KACxC,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;CACjC;AAED;;;GAGG;AAEH,MAAM,MAAM,eAAe,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@akinon/app-shared",
   "description": "Shared utilities and helper functions for app-shell and app-client packages.",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "private": false,
   "type": "module",
   "main": "dist/index.js",