@elliemae/microfe-common 2.0.0-next.40 → 2.0.0-next.42

package/dist/esm/scriptingObject.js

@@ -1,32 +1,15 @@
-var __defProp = Object.defineProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField = (obj, key, value) => {
-  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
-var __accessCheck = (obj, member, msg) => {
-  if (!member.has(obj))
-    throw TypeError("Cannot " + msg);
-};
-var __privateGet = (obj, member, getter) => {
-  __accessCheck(obj, member, "read from private field");
-  return getter ? getter.call(obj) : member.get(obj);
-};
-var __privateAdd = (obj, member, value) => {
-  if (member.has(obj))
-    throw TypeError("Cannot add the same private member more than once");
-  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
-};
-var __privateSet = (obj, member, value, setter) => {
-  __accessCheck(obj, member, "write to private field");
-  setter ? setter.call(obj, value) : member.set(obj, value);
-  return value;
-};
-var _id, _objectType;
 import { isEvent } from "./event.js";
 const FUNCTION = "function";
 const isPublicFunction = (value, fnName) => typeof value === FUNCTION && !!fnName && !fnName.startsWith("_");
 class ScriptingObject {
+  /**
+   * unique id of the scripting object
+   */
+  #id;
+  /**
+   * type of the scripting object
+   */
+  #objectType = "Object";
   /**
    * Creates an instance of ScriptingObject.
    *
@@ -34,67 +17,57 @@ class ScriptingObject {
    * @param objectType type of the scripting object
    */
   constructor(objectId, objectType) {
-    /**
-     * unique id of the scripting object
-     */
-    __privateAdd(this, _id, void 0);
-    /**
-     * type of the scripting object
-     */
-    __privateAdd(this, _objectType, "Object");
-    /**
-     * transform the scripting object to a format suitable for transmitting over window.postMessage
-     *
-     * @returns marshalled scripting object
-     */
-    // eslint-disable-next-line no-underscore-dangle
-    __publicField(this, "_toJSON", () => {
-      const functions = [];
-      const events = [];
-      Object.keys(this).forEach((property) => {
-        const value = this[property];
-        if (isEvent(value)) {
-          events.push(property);
-        } else if (isPublicFunction(value, property)) {
-          functions.push(property);
-        }
-      });
-      return {
-        objectId: __privateGet(this, _id),
-        objectType: __privateGet(this, _objectType),
-        functions,
-        events
-      };
-    });
-    /**
-     * dispose the scripting object
-     */
-    // eslint-disable-next-line no-underscore-dangle
-    __publicField(this, "_dispose", () => {
-    });
-    /**
-     * dispose the scripting object
-     */
-    __publicField(this, "dispose", () => {
-    });
-    __privateSet(this, _id, objectId);
-    __privateSet(this, _objectType, objectType || __privateGet(this, _objectType));
+    this.#id = objectId;
+    this.#objectType = objectType || this.#objectType;
   }
   /**
    * get unique id of the scripting object
    */
   get id() {
-    return __privateGet(this, _id);
+    return this.#id;
   }
   /**
    * get type of the scripting object
    */
   get objectType() {
-    return __privateGet(this, _objectType);
+    return this.#objectType;
   }
+  /**
+   * transform the scripting object to a format suitable for transmitting over window.postMessage
+   *
+   * @returns marshalled scripting object
+   */
+  // eslint-disable-next-line no-underscore-dangle
+  _toJSON = () => {
+    const functions = [];
+    const events = [];
+    Object.keys(this).forEach((property) => {
+      const value = this[property];
+      if (isEvent(value)) {
+        events.push(property);
+      } else if (isPublicFunction(value, property)) {
+        functions.push(property);
+      }
+    });
+    return {
+      objectId: this.#id,
+      objectType: this.#objectType,
+      functions,
+      events
+    };
+  };
+  /**
+   * dispose the scripting object
+   */
+  // eslint-disable-next-line no-underscore-dangle
+  _dispose = () => {
+  };
+  /**
+   * dispose the scripting object
+   */
+  dispose = () => {
+  };
 }
-_id = new WeakMap();
-_objectType = new WeakMap();
 export {
   ScriptingObject
 };

package/dist/esm/scriptingObjectManager.js

@@ -0,0 +1,191 @@
+var SecurityContext = /* @__PURE__ */ ((SecurityContext2) => {
+  SecurityContext2["USER"] = "USER";
+  SecurityContext2["PARTNER"] = "PARTNER";
+  return SecurityContext2;
+})(SecurityContext || {});
+class ScriptingObjectManager {
+  /**
+   * collection of registered scripting objects
+   */
+  #scriptingObjects = /* @__PURE__ */ new Map();
+  /**
+   * collection of proxied scripting objects for each guest
+   */
+  #guestScriptingObjects = /* @__PURE__ */ new Map();
+  #addGuestScriptingObject = (params) => {
+    const { so, guestId } = params;
+    const objectId = so.id.toLowerCase();
+    const guestSOs = this.#guestScriptingObjects.get(guestId);
+    if (!guestSOs) {
+      this.#guestScriptingObjects.set(guestId, /* @__PURE__ */ new Map([[objectId, params]]));
+    } else {
+      if (guestSOs.has(objectId))
+        throw new Error(
+          `Scripting Object ${so.id} already exists for guest ${guestId}`
+        );
+      guestSOs.set(objectId, params);
+    }
+  };
+  #disposeSO = ({ so }) => {
+    if (so._dispose && typeof so._dispose === "function") {
+      so._dispose();
+    }
+  };
+  #getGuestScriptingObject = ({
+    objectId,
+    guestId
+  }) => {
+    const moduleSOs = this.#guestScriptingObjects.get(guestId);
+    if (moduleSOs) {
+      return moduleSOs.get(objectId) ?? null;
+    }
+    return null;
+  };
+  #removeGuestScriptingObject = ({
+    objectId,
+    guestId
+  } = {}) => {
+    if (guestId) {
+      if (!objectId) {
+        const sosInfo = this.#guestScriptingObjects.get(guestId);
+        if (sosInfo) {
+          sosInfo.forEach(this.#disposeSO);
+        }
+        this.#guestScriptingObjects.delete(guestId);
+        return;
+      }
+      const moduleSOs = this.#guestScriptingObjects.get(guestId);
+      if (moduleSOs) {
+        const soInfo = moduleSOs.get(objectId);
+        if (soInfo)
+          this.#disposeSO(soInfo);
+        moduleSOs.delete(objectId);
+      }
+    } else if (objectId) {
+      this.#guestScriptingObjects.forEach((moduleSOs) => {
+        const soInfo = moduleSOs.get(objectId);
+        if (soInfo)
+          this.#disposeSO(soInfo);
+        moduleSOs.delete(objectId);
+      });
+    }
+  };
+  /**
+   * attach guest context to the scripting object methods
+   *
+   * @param root0
+   * @param root0.so
+   * @param root0.guest
+   * @returns proxies scripting object that has call context set to the guest
+   */
+  #attachCallContext = ({
+    so,
+    guest
+  }) => new Proxy(so, {
+    get(target, prop, receiver) {
+      const value = target[prop];
+      if (value instanceof Function && prop !== "constructor") {
+        return function(...args) {
+          const proxyRef = this;
+          Object.defineProperty(value, "callContext", {
+            value: guest,
+            enumerable: false,
+            writable: true
+          });
+          return value.apply(proxyRef === receiver ? target : proxyRef, args);
+        };
+      }
+      return value;
+    }
+  });
+  /**
+   * registers scripting object to the host
+   *
+   * @param so scripting object to register
+   * @param {AddScriptingObjectParams<ValueOf<AppObjects>>}
+   * @param params
+   */
+  addScriptingObject = (so, params) => {
+    const { guestId } = params || {};
+    if (!so?.id || !so?._toJSON) {
+      throw new Error("Object is not derived from ScriptingObject");
+    }
+    const objectId = so.id.toLowerCase();
+    if (objectId === "module" && !guestId) {
+      throw new Error(`Guest id is required to add Module scripting object`);
+    }
+    if (guestId) {
+      this.#addGuestScriptingObject({ so, ...params, guestId });
+      return;
+    }
+    if (this.#scriptingObjects.has(objectId))
+      throw new Error(`Scripting Object ${so.id} already exists`);
+    this.#scriptingObjects.set(objectId, { so, ...params });
+  };
+  /**
+   * Get reference to the scripting object proxy for a guest
+   *
+   * @param {string} objectId scripting object id
+   * @param {GuestContext} guest that is requesting the scripting object
+   * @returns proxied scripting object reference
+   */
+  getObject = (objectId, guest) => {
+    const id = objectId.toLowerCase();
+    let soInfo = null;
+    if (guest?.id) {
+      soInfo = this.#getGuestScriptingObject({
+        objectId: id,
+        guestId: guest.id
+      });
+    }
+    soInfo = soInfo ?? this.#scriptingObjects.get(id);
+    const { so } = soInfo || {};
+    if (!so)
+      return null;
+    if (!guest)
+      return so;
+    const guestSO = this.#attachCallContext({ so, guest });
+    Object.defineProperty(guestSO, "target", {
+      value: so,
+      enumerable: false,
+      configurable: false,
+      writable: true
+    });
+    return guestSO;
+  };
+  /**
+   * removes scripting object
+   *
+   * @param objectId unique id of the scripting object
+   * @param guestId unique id of the guest
+   */
+  removeScriptingObject = (objectId, guestId) => {
+    const id = objectId.toLowerCase();
+    if (guestId) {
+      this.#removeGuestScriptingObject({ objectId: id, guestId });
+    } else {
+      this.#removeGuestScriptingObject({ objectId: id });
+      const soInfo = this.#scriptingObjects.get(id);
+      if (soInfo)
+        this.#disposeSO(soInfo);
+      this.#scriptingObjects.delete(id);
+    }
+  };
+  /**
+   * removes all scripting objects
+   *
+   * @param guestId unique id of the guest
+   */
+  removeAllScriptingObjects = (guestId) => {
+    if (!guestId) {
+      this.#scriptingObjects.forEach(this.#disposeSO);
+      this.#scriptingObjects.clear();
+    } else {
+      this.#removeGuestScriptingObject({ guestId });
+    }
+  };
+}
+export {
+  ScriptingObjectManager,
+  SecurityContext
+};

package/dist/types/index.d.ts

@@ -8,3 +8,5 @@ export { ScriptingObject } from './scriptingObject.js';
 export { MessageType } from './messageType.js';
 export type { EventListeners, Listener } from './common.js';
 export type { ISSFGuest, ConnectParam, SubscribeParam as GuestSubscribeParam, UnsubscribeParam as GuestUnsubscribeParam, } from './guest.js';
+export { ScriptingObjectManager } from './scriptingObjectManager.js';
+export type { AddScriptingObjectParams, GetObjectParams, GuestContext, } from './scriptingObjectManager.js';

package/dist/types/scriptingObjectManager.d.ts

@@ -0,0 +1,97 @@
+import { ScriptingObjectTypes, IScriptingObject } from '@elliemae/pui-scripting-object';
+type ValueOf<T> = T[keyof T];
+/**
+ * collection of scripting objects
+ */
+export type ScriptingObjects = Record<string, IScriptingObject>;
+/**
+ * information about the guest
+ */
+export type GuestContext = {
+    /**
+     * unique id of the guest application
+     */
+    id: string;
+};
+/**
+ * security context under which the guest application is running
+ */
+export declare enum SecurityContext {
+    /**
+     * application is using the same security context as the host
+     */
+    USER = "USER",
+    /**
+     * application is using the partner security context
+     */
+    PARTNER = "PARTNER"
+}
+/**
+ * parameters to add scripting object
+ */
+export type AddScriptingObjectParams = {
+    /**
+     * limit scripting object only to the specified guest
+     */
+    guestId?: string;
+    /**
+     * security context under which the scripting object is available
+     */
+    securityContext?: SecurityContext;
+};
+/**
+ * parameters to get scripting object
+ */
+export type GetObjectParams = {
+    guest: GuestContext;
+};
+/**
+ * scripting object details
+ */
+export type SOInfo<Objects extends ScriptingObjects> = {
+    /**
+     * scripting object to add
+     */
+    so: ValueOf<Objects>;
+    /**
+     * limit scripting object only to the specified guest
+     */
+    guestId?: string;
+    /**
+     * security context under which the scripting object is available
+     */
+    securityContext?: SecurityContext;
+};
+export declare class ScriptingObjectManager<AppObjects extends ScriptingObjects = Partial<ScriptingObjectTypes>> {
+    #private;
+    /**
+     * registers scripting object to the host
+     *
+     * @param so scripting object to register
+     * @param {AddScriptingObjectParams<ValueOf<AppObjects>>}
+     * @param params
+     */
+    addScriptingObject: <SO extends ValueOf<AppObjects>>(so: SO, params?: AddScriptingObjectParams) => void;
+    /**
+     * Get reference to the scripting object proxy for a guest
+     *
+     * @param {string} objectId scripting object id
+     * @param {GuestContext} guest that is requesting the scripting object
+     * @returns proxied scripting object reference
+     */
+    getObject: <ObjectId extends Extract<keyof AppObjects, string>>(objectId: ObjectId, guest?: GuestContext) => AppObjects[ObjectId] | null;
+    /**
+     * removes scripting object
+     *
+     * @param objectId unique id of the scripting object
+     * @param guestId unique id of the guest
+     */
+    removeScriptingObject: (objectId: Extract<keyof AppObjects, string>, guestId?: string) => void;
+    /**
+     * removes all scripting objects
+     *
+     * @param guestId unique id of the guest
+     */
+    removeAllScriptingObjects: (guestId?: string) => void;
+}
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/microfe-common",
-  "version": "2.0.0-next.40",
+  "version": "2.0.0-next.42",
   "description": "common micro frontend functional modules",
   "repository": {
     "type": "git",
@@ -37,9 +37,9 @@
     "uuid": "~9.0.0"
   },
   "devDependencies": {
-    "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.6.0",
-    "@elliemae/pui-diagnostics": "~3.1.0",
-    "@elliemae/pui-scripting-object": "~1.19.1",
+    "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.7.0",
+    "@elliemae/pui-diagnostics": "~3.2.0",
+    "@elliemae/pui-scripting-object": "~1.20.0",
     "@types/uuid": "~9.0.1"
   },
   "scripts": {