@elliemae/pui-app-sdk 5.31.0-beta.1 → 5.31.0-beta.2

package/dist/cjs/utils/micro-frontend/index.js

@@ -40,13 +40,14 @@ var import_guest = require("./guest.js");
 var import_host = require("./host.js");
 var import_config = require("../app-config/config.js");
 var import_helpers = require("../helpers.js");
+var import_types2 = require("./types.js");
 const isHost = () => import_host.CMicroAppHost.isInitialized();
 const isGuest = () => import_guest.CMicroAppGuest.isInitialized();
 const isStandAloneGuest = () => isGuest() && window.top === window.self;
 const getLogger = () => isHost() ? import_host.CMicroAppHost.getInstance().getLogger() : import_guest.CMicroAppGuest.getInstance().getLogger();
 const isProduction = (mode) => {
   if ((0, import_helpers.isCIBuild)()) return true;
-  if (mode) return mode === "production";
+  if (mode) return mode === import_types2.LaunchMode.PRODUCTION;
   return true;
 };
 const getVersionedPath = (path) => {
@@ -65,7 +66,7 @@ const getMicroFrontEndAppConfig = (appInfo) => {
     throw new Error(
       `unable to locate application configuraiton for ${appInfo.id} under microFrontendApps section of app.config.json`
     );
-  const { mode = "production" } = microFEAppConfig;
+  const { mode = import_types2.LaunchMode.PRODUCTION } = microFEAppConfig;
   const envConfig = isProduction(mode) ? microFEAppConfig.production : microFEAppConfig.development;
   if (microFEAppConfig.production) delete microFEAppConfig.production;
   if (microFEAppConfig.development) delete microFEAppConfig.development;

package/dist/cjs/utils/micro-frontend/types.js

@@ -3,6 +3,10 @@ var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
 var __copyProps = (to, from, except, desc) => {
   if (from && typeof from === "object" || typeof from === "function") {
     for (let key of __getOwnPropNames(from))
@@ -13,4 +17,18 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var types_exports = {};
+__export(types_exports, {
+  LaunchMode: () => LaunchMode,
+  MicroAppManager: () => MicroAppManager
+});
 module.exports = __toCommonJS(types_exports);
+var LaunchMode = /* @__PURE__ */ ((LaunchMode2) => {
+  LaunchMode2["DEVELOPMENT"] = "development";
+  LaunchMode2["PRODUCTION"] = "production";
+  return LaunchMode2;
+})(LaunchMode || {});
+var MicroAppManager = /* @__PURE__ */ ((MicroAppManager2) => {
+  MicroAppManager2["SSF"] = "ssf";
+  MicroAppManager2["APPSDK"] = "appsdk";
+  return MicroAppManager2;
+})(MicroAppManager || {});

package/dist/cjs/view/guest-microapp.js

@@ -35,6 +35,7 @@ var import_jsx_runtime = require("react/jsx-runtime");
 var import_react = require("react");
 var import_styled_components = __toESM(require("styled-components"));
 var import_react_redux = require("react-redux");
+var import_types = require("../utils/micro-frontend/types.js");
 var import_app_bridge = require("../utils/micro-frontend/app-bridge.js");
 var import_ssf_host2 = require("../utils/micro-frontend/ssf-host.js");
 var import_actions = require("../data/wait-message/actions.js");
@@ -54,7 +55,8 @@ const useAppRenderer = (props) => {
     initialRoute,
     onLoadComplete,
     onUnloadComplete,
-    containerId
+    containerId,
+    ssfAppOptions = {}
   } = props;
   const dispatch = (0, import_react_redux.useDispatch)();
   const getConfig = (0, import_react.useCallback)(
@@ -73,18 +75,25 @@ const useAppRenderer = (props) => {
       await unloadInProgress;
       dispatch(import_actions.waitMessage.open());
       try {
-        const { ssfOnly, hostUrl, name } = getConfig();
-        if (ssfOnly) {
+        const {
+          microappManager = import_types.MicroAppManager.APPSDK,
+          hostUrl,
+          name
+        } = getConfig();
+        if (microappManager === import_types.MicroAppManager.SSF) {
           ssfHost = (0, import_ssf_host2.getSSFHost)();
           if (!ssfHost)
             throw new Error(`Failed to load ${id}, SSFHost not initialized`);
           if (isMounted) {
+            const { searchParams, ...guestOptions } = ssfAppOptions;
             const guest = ssfHost.loadGuest({
               id,
               url: hostUrl,
               title: name,
               targetElement: document.getElementById(containerId),
-              onLoad: onLoadComplete
+              searchParams,
+              onLoad: onLoadComplete,
+              options: guestOptions
             });
             instanceId = guest.id;
           }
@@ -150,7 +159,8 @@ const useAppRenderer = (props) => {
     id,
     onLoadComplete,
     onUnloadComplete,
-    getConfig
+    getConfig,
+    ssfAppOptions
   ]);
 };
 const GuestMicroApp = (0, import_react.memo)(

package/dist/cjs/view/tests/app.config.json

@@ -18,13 +18,7 @@
     "ssfapp": {
       "name": "SSF App",
       "hostUrl": "./ssfapp",
-      "ssfOnly": true,
-      "development": {
-        "files": ["index.js"]
-      },
-      "production": {
-        "files": ["index.js"]
-      }
+      "microappManager": "ssf"
     },
     "taskapp": {
       "name": "Task",

package/dist/esm/utils/micro-frontend/index.js

@@ -3,13 +3,14 @@ import { CMicroAppGuest } from "./guest.js";
 import { CMicroAppHost } from "./host.js";
 import { getAppConfigValue } from "../app-config/config.js";
 import { convertRelativeToAbsoluteUrl, isCIBuild } from "../helpers.js";
+import { LaunchMode } from "./types.js";
 const isHost = () => CMicroAppHost.isInitialized();
 const isGuest = () => CMicroAppGuest.isInitialized();
 const isStandAloneGuest = () => isGuest() && window.top === window.self;
 const getLogger = () => isHost() ? CMicroAppHost.getInstance().getLogger() : CMicroAppGuest.getInstance().getLogger();
 const isProduction = (mode) => {
   if (isCIBuild()) return true;
-  if (mode) return mode === "production";
+  if (mode) return mode === LaunchMode.PRODUCTION;
   return true;
 };
 const getVersionedPath = (path) => {
@@ -28,7 +29,7 @@ const getMicroFrontEndAppConfig = (appInfo) => {
     throw new Error(
       `unable to locate application configuraiton for ${appInfo.id} under microFrontendApps section of app.config.json`
     );
-  const { mode = "production" } = microFEAppConfig;
+  const { mode = LaunchMode.PRODUCTION } = microFEAppConfig;
   const envConfig = isProduction(mode) ? microFEAppConfig.production : microFEAppConfig.development;
   if (microFEAppConfig.production) delete microFEAppConfig.production;
   if (microFEAppConfig.development) delete microFEAppConfig.development;

package/dist/esm/utils/micro-frontend/types.js

@@ -0,0 +1,14 @@
+var LaunchMode = /* @__PURE__ */ ((LaunchMode2) => {
+  LaunchMode2["DEVELOPMENT"] = "development";
+  LaunchMode2["PRODUCTION"] = "production";
+  return LaunchMode2;
+})(LaunchMode || {});
+var MicroAppManager = /* @__PURE__ */ ((MicroAppManager2) => {
+  MicroAppManager2["SSF"] = "ssf";
+  MicroAppManager2["APPSDK"] = "appsdk";
+  return MicroAppManager2;
+})(MicroAppManager || {});
+export {
+  LaunchMode,
+  MicroAppManager
+};

package/dist/esm/view/guest-microapp.js

@@ -2,6 +2,7 @@ import { jsx } from "react/jsx-runtime";
 import { memo, useLayoutEffect, useRef, useCallback } from "react";
 import styled from "styled-components";
 import { useDispatch } from "react-redux";
+import { MicroAppManager } from "../utils/micro-frontend/types.js";
 import { getAppBridge } from "../utils/micro-frontend/app-bridge.js";
 import { getSSFHost } from "../utils/micro-frontend/ssf-host.js";
 import { waitMessage } from "../data/wait-message/actions.js";
@@ -24,7 +25,8 @@ const useAppRenderer = (props) => {
     initialRoute,
     onLoadComplete,
     onUnloadComplete,
-    containerId
+    containerId,
+    ssfAppOptions = {}
   } = props;
   const dispatch = useDispatch();
   const getConfig = useCallback(
@@ -43,18 +45,25 @@ const useAppRenderer = (props) => {
       await unloadInProgress;
       dispatch(waitMessage.open());
       try {
-        const { ssfOnly, hostUrl, name } = getConfig();
-        if (ssfOnly) {
+        const {
+          microappManager = MicroAppManager.APPSDK,
+          hostUrl,
+          name
+        } = getConfig();
+        if (microappManager === MicroAppManager.SSF) {
           ssfHost = getSSFHost();
           if (!ssfHost)
             throw new Error(`Failed to load ${id}, SSFHost not initialized`);
           if (isMounted) {
+            const { searchParams, ...guestOptions } = ssfAppOptions;
             const guest = ssfHost.loadGuest({
               id,
               url: hostUrl,
               title: name,
               targetElement: document.getElementById(containerId),
-              onLoad: onLoadComplete
+              searchParams,
+              onLoad: onLoadComplete,
+              options: guestOptions
             });
             instanceId = guest.id;
           }
@@ -120,7 +129,8 @@ const useAppRenderer = (props) => {
     id,
     onLoadComplete,
     onUnloadComplete,
-    getConfig
+    getConfig,
+    ssfAppOptions
   ]);
 };
 const GuestMicroApp = memo(

package/dist/esm/view/tests/app.config.json

@@ -18,13 +18,7 @@
     "ssfapp": {
       "name": "SSF App",
       "hostUrl": "./ssfapp",
-      "ssfOnly": true,
-      "development": {
-        "files": ["index.js"]
-      },
-      "production": {
-        "files": ["index.js"]
-      }
+      "microappManager": "ssf"
     },
     "taskapp": {
       "name": "Task",

package/dist/types/lib/utils/micro-frontend/types.d.ts

@@ -1,23 +1,86 @@
 import { InitOptions } from '@elliemae/pui-micro-frontend-base';
 import { Events, ScriptingObjectTypes } from '@elliemae/pui-scripting-object';
+/**
+ * Files specific to the mode of the micro-frontend application.
+ */
 type EnvConfig = {
+    /**
+     * Array of file paths specific to the environment (development or production).
+     * relative or absolute URLs
+     */
     files: Array<string>;
 };
+/**
+ * Modes in which a micro-frontend application can operate.
+ */
+export declare enum LaunchMode {
+    DEVELOPMENT = "development",
+    PRODUCTION = "production"
+}
+/**
+ * Library that manages the micro-frontend application.
+ */
+export declare enum MicroAppManager {
+    SSF = "ssf",
+    APPSDK = "appsdk"
+}
+/**
+ * Configuration object for a micro-frontend application.
+ */
 export type MicroAppConfig = {
+    /**
+     * Unique identifier for the micro-frontend application.
+     */
     id: string;
+    /**
+     * Human-readable name for the micro-frontend application.
+     */
     name: string;
-    mode?: string;
+    /**
+     * Optional title for the micro-frontend application.
+     */
+    title?: string;
+    /**
+     * Mode in which the micro-frontend operates (e.g., 'development', 'production').
+     */
+    mode?: LaunchMode;
+    /**
+     * Base URL where the micro-frontend is hosted.
+     */
     hostUrl?: string;
+    /**
+     * Path to the manifest file for the micro-frontend.
+     */
     manifestPath?: string;
+    /**
+     * Route to the home page of the micro-frontend application.
+     */
     homeRoute: string;
+    /**
+     * If true, the micro-frontend is treated as a JavaScript module.
+     */
     isJsModule?: boolean;
     /**
-     * If true, application will only be loaded via SSFHost and not AppBridge.
+     * Library that manages the micro-frontend application (e.g., 'ssf', 'appsdk').
+     * @default 'appsdk'
+     */
+    microappManager?: MicroAppManager;
+    /**
+     * Array of file paths required by the micro-frontend application.
+     * relative or absolute URLs
      */
-    ssfOnly?: boolean;
     files?: Array<string>;
+    /**
+     * files specific to the development build.
+     */
     development?: EnvConfig;
+    /**
+     * files specific to the production build.
+     */
     production?: EnvConfig;
+    /**
+     * The Document object associated with the micro-frontend application.
+     */
     documentEle: Document;
 } & InitOptions<Partial<ScriptingObjectTypes>, Events>;
 export {};

package/dist/types/lib/view/guest-microapp.d.ts

@@ -1,10 +1,59 @@
+import { OpenMode, IFrameSandboxValues, WindowFeatures } from '@elliemae/ssf-host';
 import { OpenAppParams } from '@elliemae/pui-app-bridge';
 export type OnLoadCompleteFn = (instanceId: string) => void;
 export type OnUnloadCompleteFn = () => void;
+/**
+ * parameters for the ssf microapp components
+ */
+export type SSFMicroAppParams<SearchParams> = {
+    /**
+     * individual query parameters indicating guest application's url parameter string
+     */
+    searchParams?: SearchParams;
+    /**
+     * mode of opening the guest application, popup or embed
+     * @default OpenMode.Embed
+     */
+    openMode?: OpenMode;
+    /**
+     * flag to disable sandboxing for iframe
+     * @default false
+     */
+    disableSandbox?: boolean;
+    /**
+     * sandbox values for iframe
+     * @default [IFrameSandboxValues.AllowScripts, IFrameSandboxValues.AllowPopups, IFrameSandboxValues.AllowModals, IFrameSandboxValues.AllowForms, IFrameSandboxValues.AllowDownloads, IFrameSandboxValues.AllowSameOrigin ]
+     */
+    sandboxValues?: Array<IFrameSandboxValues>;
+    /**
+     * resize the iframe to fit the content inside
+     * @default true
+     */
+    fitToContent?: boolean;
+    /**
+     * css style for the microapp iframe
+     */
+    style?: string;
+    /**
+     * features for the popup window
+     * @default { width: 800, height: 600, top: 100, left: 100 }
+     */
+    popupWindowFeatures?: WindowFeatures;
+    /**
+     * permission policy for the guest iframe
+     * check https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/iframe#allow for more details
+     * @example "microphone 'self' https://example.com; geolocation 'none'"
+     */
+    permissionPolicy?: string;
+};
+/**
+ * Parameters for the GuestMicroApp component.
+ */
 export type GuestMicroAppParams = OpenAppParams & {
     onLoadComplete?: OnLoadCompleteFn;
     onUnloadComplete?: OnUnloadCompleteFn;
     containerId?: string;
+    ssfAppOptions?: SSFMicroAppParams<Record<string, string | number | boolean>>;
 };
 /**
  * Component to load a guest microapp