@elliemae/microfe-common 2.9.11 → 2.16.5

package/dist/cjs/event.js

@@ -26,10 +26,6 @@ __export(event_exports, {
 module.exports = __toCommonJS(event_exports);
 class Event {
   /* eslint-enable indent */
-  /**
-   * scripting object that owns this event
-   */
-  scriptingObject;
   /**
    * name of the event
    */
@@ -38,10 +34,6 @@ class Event {
    * scripting object id that owns this event
    */
   objectId;
-  /**
-   * flag indicating this event requires feedback from all of the listeners
-   */
-  requiresFeedback;
   /**
    * unique id of the event
    */
@@ -51,14 +43,12 @@ class Event {
    * @param {EventParam} param - parameters for creating an event
    */
   constructor(param) {
-    const { name, requiresFeedback = false, so } = param;
+    const { name, objectId } = param;
     if (!name) throw new Error("Event name is required");
-    if (!so) throw new Error("Scripting object is required");
-    this.scriptingObject = so;
-    this.objectId = so.id;
+    if (!objectId) throw new Error("Scripting object id is required");
+    this.objectId = objectId;
     this.name = name;
     this.id = `${this.objectId}.${this.name}`.toLowerCase();
-    this.requiresFeedback = requiresFeedback;
   }
 }
 class ProxyEvent {
@@ -70,7 +60,11 @@ class ProxyEvent {
   static [Symbol.hasInstance](obj) {
     return obj.getType?.() === "ProxyEvent";
   }
-  /* eslint-enable indent */
+  /* eslint-enbale indent */
+  /**
+   * module that owns this event management. SSF Guest or App Bridge host
+   */
+  #eventSrc;
   /**
    * unique id of scripting object
    */
@@ -95,11 +89,31 @@ class ProxyEvent {
    * @param {ProxyEventParam} param - parameter for the constructor
    */
   constructor(param) {
-    const { name, objectId } = param;
+    const { name, objectId, eventSrc } = param;
     this.objectId = objectId;
     this.name = name;
+    this.#eventSrc = eventSrc;
     this.id = `${this.objectId}.${this.name}`.toLowerCase();
   }
+  /**
+   * subscribe to an scripting object event
+   * @param callback event listener
+   * @returns subscription token
+   */
+  subscribe = (callback) => this.#eventSrc.subscribe({
+    eventId: this.id,
+    callback
+  });
+  /**
+   * unsubscribe from an scripting object event
+   * @param token subscription token
+   */
+  unsubscribe = (token) => {
+    this.#eventSrc.unsubscribe({
+      eventId: this.id,
+      token
+    });
+  };
 }
 const isEvent = (value) => value instanceof Event;
 const getEventId = (objectId, eventName) => `${objectId.toLowerCase()}.${eventName.toLowerCase()}`;

package/dist/cjs/index.js

@@ -24,7 +24,10 @@ __export(index_exports, {
   Remoting: () => import_remoting.Remoting,
   ScriptingObject: () => import_scriptingObject.ScriptingObject,
   ScriptingObjectManager: () => import_scriptingObjectManager.ScriptingObjectManager,
+  ScriptingObjectProxy: () => import_proxy.ScriptingObjectProxy,
   getEventId: () => import_event.getEventId,
+  isPublicFunction: () => import_scriptingObject.isPublicFunction,
+  isScriptingObjectProxy: () => import_proxy.isScriptingObjectProxy,
   sendMessage: () => import_remoting.sendMessage
 });
 module.exports = __toCommonJS(index_exports);
@@ -34,3 +37,4 @@ var import_event2 = require("./event.js");
 var import_scriptingObject = require("./scriptingObject.js");
 var import_messageType = require("./messageType.js");
 var import_scriptingObjectManager = require("./scriptingObjectManager.js");
+var import_proxy = require("./proxy.js");

package/dist/cjs/messageType.js

@@ -22,17 +22,18 @@ __export(messageType_exports, {
 });
 module.exports = __toCommonJS(messageType_exports);
 var MessageType = /* @__PURE__ */ ((MessageType2) => {
-  MessageType2["GuestReady"] = "guest:ready";
   MessageType2["GuestClose"] = "guest:close";
+  MessageType2["GuestFocus"] = "guest:focus";
+  MessageType2["GuestReady"] = "guest:ready";
   MessageType2["GuestReadyComplete"] = "guest:readyComplete";
   MessageType2["GuestResize"] = "guest:resize";
-  MessageType2["GuestFocus"] = "guest:focus";
   MessageType2["HandShake"] = "handshake";
   MessageType2["HandShakeAck"] = "handshake:ack";
-  MessageType2["ObjectInvoke"] = "object:invoke";
-  MessageType2["ObjectGet"] = "object:get";
-  MessageType2["ObjectEvent"] = "object:event";
-  MessageType2["HostConfig"] = "host:config";
   MessageType2["HostClose"] = "host:close";
+  MessageType2["HostConfig"] = "host:config";
+  MessageType2["ListObjects"] = "list:objects";
+  MessageType2["ObjectEvent"] = "object:event";
+  MessageType2["ObjectGet"] = "object:get";
+  MessageType2["ObjectInvoke"] = "object:invoke";
   return MessageType2;
 })(MessageType || {});

package/dist/cjs/proxy.js

@@ -0,0 +1,53 @@
+"use strict";
+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))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var proxy_exports = {};
+__export(proxy_exports, {
+  ScriptingObjectProxy: () => ScriptingObjectProxy,
+  isScriptingObjectProxy: () => isScriptingObjectProxy
+});
+module.exports = __toCommonJS(proxy_exports);
+class ScriptingObjectProxy {
+  /**
+   * proxy type
+   */
+  __TYPE__ = "Proxy";
+  /**
+   * unique id of scripting object
+   */
+  id;
+  /**
+   * type of scripting object
+   */
+  objectType;
+  /**
+   * Creates a new instance of the Scripting Object Proxy
+   * @param objectId unique id of scripting object
+   * @param objectType type of scripting object
+   */
+  constructor(objectId, objectType) {
+    this.id = objectId;
+    this.objectType = objectType;
+  }
+}
+const isScriptingObjectProxy = (value) => (
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+  value?.constructor?.name === "Proxy" || // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+  value?.constructor?.name === "ScriptingObjectProxy" || // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, no-underscore-dangle
+  value?.__TYPE__ === "Proxy"
+);

package/dist/cjs/scriptingObject.js

@@ -18,7 +18,8 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var scriptingObject_exports = {};
 __export(scriptingObject_exports, {
-  ScriptingObject: () => ScriptingObject
+  ScriptingObject: () => ScriptingObject,
+  isPublicFunction: () => isPublicFunction
 });
 module.exports = __toCommonJS(scriptingObject_exports);
 var import_event = require("./event.js");

package/dist/cjs/scriptingObjectManager.js

@@ -108,34 +108,6 @@ class ScriptingObjectManager {
       });
     }
   };
-  /**
-   * 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,
-            configurable: true,
-            enumerable: true,
-            writable: true
-          });
-          return value.apply(proxyRef === receiver ? target : proxyRef, args);
-        };
-      }
-      return value;
-    }
-  });
   /**
    * registers scripting object to the host
    * @param so scripting object to register
@@ -174,15 +146,18 @@ class ScriptingObjectManager {
     soInfo = soInfo ?? this.#scriptingObjects.get(id) ?? null;
     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;
+    return so;
+  };
+  /**
+   * list name of scripting objects for the given guest
+   * @param guestId unique id of the guest
+   * @returns name of scripting objects for the given guest
+   */
+  listScriptingObjects = (guestId) => {
+    let objects = Array.from(this.#scriptingObjects.keys());
+    const guestSOs = this.#guestScriptingObjects.get(guestId);
+    objects = guestSOs ? objects.concat(Array.from(guestSOs.keys())) : objects;
+    return Array.from(new Set(objects));
   };
   /**
    * removes scripting object

package/dist/esm/event.js

@@ -1,9 +1,5 @@
 class Event {
   /* eslint-enable indent */
-  /**
-   * scripting object that owns this event
-   */
-  scriptingObject;
   /**
    * name of the event
    */
@@ -12,10 +8,6 @@ class Event {
    * scripting object id that owns this event
    */
   objectId;
-  /**
-   * flag indicating this event requires feedback from all of the listeners
-   */
-  requiresFeedback;
   /**
    * unique id of the event
    */
@@ -25,14 +17,12 @@ class Event {
    * @param {EventParam} param - parameters for creating an event
    */
   constructor(param) {
-    const { name, requiresFeedback = false, so } = param;
+    const { name, objectId } = param;
     if (!name) throw new Error("Event name is required");
-    if (!so) throw new Error("Scripting object is required");
-    this.scriptingObject = so;
-    this.objectId = so.id;
+    if (!objectId) throw new Error("Scripting object id is required");
+    this.objectId = objectId;
     this.name = name;
     this.id = `${this.objectId}.${this.name}`.toLowerCase();
-    this.requiresFeedback = requiresFeedback;
   }
 }
 class ProxyEvent {
@@ -44,7 +34,11 @@ class ProxyEvent {
   static [Symbol.hasInstance](obj) {
     return obj.getType?.() === "ProxyEvent";
   }
-  /* eslint-enable indent */
+  /* eslint-enbale indent */
+  /**
+   * module that owns this event management. SSF Guest or App Bridge host
+   */
+  #eventSrc;
   /**
    * unique id of scripting object
    */
@@ -69,11 +63,31 @@ class ProxyEvent {
    * @param {ProxyEventParam} param - parameter for the constructor
    */
   constructor(param) {
-    const { name, objectId } = param;
+    const { name, objectId, eventSrc } = param;
     this.objectId = objectId;
     this.name = name;
+    this.#eventSrc = eventSrc;
     this.id = `${this.objectId}.${this.name}`.toLowerCase();
   }
+  /**
+   * subscribe to an scripting object event
+   * @param callback event listener
+   * @returns subscription token
+   */
+  subscribe = (callback) => this.#eventSrc.subscribe({
+    eventId: this.id,
+    callback
+  });
+  /**
+   * unsubscribe from an scripting object event
+   * @param token subscription token
+   */
+  unsubscribe = (token) => {
+    this.#eventSrc.unsubscribe({
+      eventId: this.id,
+      token
+    });
+  };
 }
 const isEvent = (value) => value instanceof Event;
 const getEventId = (objectId, eventName) => `${objectId.toLowerCase()}.${eventName.toLowerCase()}`;

package/dist/esm/index.js

@@ -1,9 +1,10 @@
 import { Remoting, sendMessage } from "./remoting.js";
 import { getEventId, ProxyEvent } from "./event.js";
 import { Event } from "./event.js";
-import { ScriptingObject } from "./scriptingObject.js";
+import { ScriptingObject, isPublicFunction } from "./scriptingObject.js";
 import { MessageType } from "./messageType.js";
 import { ScriptingObjectManager } from "./scriptingObjectManager.js";
+import { ScriptingObjectProxy, isScriptingObjectProxy } from "./proxy.js";
 export {
   Event,
   MessageType,
@@ -11,6 +12,9 @@ export {
   Remoting,
   ScriptingObject,
   ScriptingObjectManager,
+  ScriptingObjectProxy,
   getEventId,
+  isPublicFunction,
+  isScriptingObjectProxy,
   sendMessage
 };

package/dist/esm/messageType.js

@@ -1,16 +1,17 @@
 var MessageType = /* @__PURE__ */ ((MessageType2) => {
-  MessageType2["GuestReady"] = "guest:ready";
   MessageType2["GuestClose"] = "guest:close";
+  MessageType2["GuestFocus"] = "guest:focus";
+  MessageType2["GuestReady"] = "guest:ready";
   MessageType2["GuestReadyComplete"] = "guest:readyComplete";
   MessageType2["GuestResize"] = "guest:resize";
-  MessageType2["GuestFocus"] = "guest:focus";
   MessageType2["HandShake"] = "handshake";
   MessageType2["HandShakeAck"] = "handshake:ack";
-  MessageType2["ObjectInvoke"] = "object:invoke";
-  MessageType2["ObjectGet"] = "object:get";
-  MessageType2["ObjectEvent"] = "object:event";
-  MessageType2["HostConfig"] = "host:config";
   MessageType2["HostClose"] = "host:close";
+  MessageType2["HostConfig"] = "host:config";
+  MessageType2["ListObjects"] = "list:objects";
+  MessageType2["ObjectEvent"] = "object:event";
+  MessageType2["ObjectGet"] = "object:get";
+  MessageType2["ObjectInvoke"] = "object:invoke";
   return MessageType2;
 })(MessageType || {});
 export {

package/dist/esm/proxy.js

@@ -0,0 +1,33 @@
+class ScriptingObjectProxy {
+  /**
+   * proxy type
+   */
+  __TYPE__ = "Proxy";
+  /**
+   * unique id of scripting object
+   */
+  id;
+  /**
+   * type of scripting object
+   */
+  objectType;
+  /**
+   * Creates a new instance of the Scripting Object Proxy
+   * @param objectId unique id of scripting object
+   * @param objectType type of scripting object
+   */
+  constructor(objectId, objectType) {
+    this.id = objectId;
+    this.objectType = objectType;
+  }
+}
+const isScriptingObjectProxy = (value) => (
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+  value?.constructor?.name === "Proxy" || // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+  value?.constructor?.name === "ScriptingObjectProxy" || // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, no-underscore-dangle
+  value?.__TYPE__ === "Proxy"
+);
+export {
+  ScriptingObjectProxy,
+  isScriptingObjectProxy
+};

package/dist/esm/scriptingObject.js

@@ -67,5 +67,6 @@ class ScriptingObject {
   };
 }
 export {
-  ScriptingObject
+  ScriptingObject,
+  isPublicFunction
 };

package/dist/esm/scriptingObjectManager.js

@@ -83,34 +83,6 @@ class ScriptingObjectManager {
       });
     }
   };
-  /**
-   * 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,
-            configurable: true,
-            enumerable: true,
-            writable: true
-          });
-          return value.apply(proxyRef === receiver ? target : proxyRef, args);
-        };
-      }
-      return value;
-    }
-  });
   /**
    * registers scripting object to the host
    * @param so scripting object to register
@@ -149,15 +121,18 @@ class ScriptingObjectManager {
     soInfo = soInfo ?? this.#scriptingObjects.get(id) ?? null;
     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;
+    return so;
+  };
+  /**
+   * list name of scripting objects for the given guest
+   * @param guestId unique id of the guest
+   * @returns name of scripting objects for the given guest
+   */
+  listScriptingObjects = (guestId) => {
+    let objects = Array.from(this.#scriptingObjects.keys());
+    const guestSOs = this.#guestScriptingObjects.get(guestId);
+    objects = guestSOs ? objects.concat(Array.from(guestSOs.keys())) : objects;
+    return Array.from(new Set(objects));
   };
   /**
    * removes scripting object

package/dist/types/lib/event.d.ts

@@ -1,5 +1,44 @@
-import type { IScriptingObject, IEvent, Events } from '@elliemae/pui-scripting-object';
-import { EventListeners } from './common.js';
+import type { IEvent, Events } from '@elliemae/pui-scripting-object';
+import { EventListeners, Listener } from './common.js';
+/**
+ * parameters for subscribing to an event
+ */
+export type SubscribeParam<EventId, EventListener extends Listener<any, any, any, any>> = {
+    /**
+     * unique id of the event
+     */
+    eventId: EventId;
+    /**
+     * event listener
+     */
+    callback: EventListener;
+};
+/**
+ * parameters for unsubscribing from an event
+ */
+export type UnsubscribeParam<EventId> = {
+    /**
+     * unique id of the event
+     */
+    eventId: EventId;
+    /**
+     * subscription token
+     */
+    token: string;
+};
+export interface IEventManager<AppEvents extends EventListeners = Events> {
+    /**
+     * subscribe to an scripting object event
+     * @param {SubscribeParam<EventId, AppEvents[EventId]>} param - parameters for subscribing to an event
+     * @returns subscription token
+     */
+    subscribe: <EventId extends Extract<keyof AppEvents, string>>(param: SubscribeParam<EventId, AppEvents[EventId]>) => string;
+    /**
+     * unsubscribe from an scripting object event
+     * @param {UnsubscribeParam<EventId>} param - parameters for unsubscribing from an event
+     */
+    unsubscribe: <EventId extends Extract<keyof AppEvents, string>>(param: UnsubscribeParam<EventId>) => void;
+}
 /**
  * Interface for scripting object proxy events
  */
@@ -22,26 +61,18 @@ export interface IScriptingObjectProxyEvent<EventsList extends EventListeners =
  */
 export type EventParam = {
     /**
-     * name of the event
-     */
-    name: string;
-    /**
-     * flag indicating this event requires feedback from all of the listeners
+     * scripting object id that owns this event
      */
-    requiresFeedback: boolean;
+    objectId: string;
     /**
-     * scripting object that owns this event
+     * name of the event
      */
-    so: IScriptingObject;
+    name: string;
 };
 /**
  * Base class for all events
  */
-export declare class Event<EventsList extends EventListeners = Events> implements IEvent {
-    /**
-     * scripting object that owns this event
-     */
-    readonly scriptingObject: IScriptingObject;
+export declare class Event<AppEvents extends EventListeners = Events> implements IEvent {
     /**
      * name of the event
      */
@@ -50,14 +81,10 @@ export declare class Event<EventsList extends EventListeners = Events> implement
      * scripting object id that owns this event
      */
     readonly objectId: string;
-    /**
-     * flag indicating this event requires feedback from all of the listeners
-     */
-    readonly requiresFeedback: boolean;
     /**
      * unique id of the event
      */
-    readonly id: Extract<keyof EventsList, string>;
+    readonly id: Extract<keyof AppEvents, string>;
     /**
      * Create an event object
      * @param {EventParam} param - parameters for creating an event
@@ -67,7 +94,7 @@ export declare class Event<EventsList extends EventListeners = Events> implement
 /**
  * ProxyEvent constructor parameter
  */
-export type ProxyEventParam = {
+export type ProxyEventParam<AppEvents extends EventListeners = Events> = {
     /**
      * name of the event
      */
@@ -76,12 +103,17 @@ export type ProxyEventParam = {
      * unique id of scripting object
      */
     objectId: string;
+    /**
+     * module that owns this event management. SSF Guest or App Bridge host
+     */
+    eventSrc: IEventManager<AppEvents>;
 };
 /**
  * Scripting Object Proxy Event implementation
  * @typeParam AppEvents - type of the events that the scripting object supports
  */
 export declare class ProxyEvent<AppEvents extends EventListeners = Events> implements IScriptingObjectProxyEvent<AppEvents> {
+    #private;
     /**
      * check if given object is an instance of ProxyEvent
      * @param obj object to be compared
@@ -109,7 +141,18 @@ export declare class ProxyEvent<AppEvents extends EventListeners = Events> imple
      * Create a new instance of the Scripting Object Proxy Event
      * @param {ProxyEventParam} param - parameter for the constructor
      */
-    constructor(param: ProxyEventParam);
+    constructor(param: ProxyEventParam<AppEvents>);
+    /**
+     * subscribe to an scripting object event
+     * @param callback event listener
+     * @returns subscription token
+     */
+    subscribe: <EventListener extends Listener<any, any, any, any>>(callback: EventListener) => string;
+    /**
+     * unsubscribe from an scripting object event
+     * @param token subscription token
+     */
+    unsubscribe: (token: string) => void;
 }
 /**
  * Check given object is an event
@@ -124,3 +167,57 @@ export declare const isEvent: (value: any) => value is Event;
  * @returns normalized event ID
  */
 export declare const getEventId: (objectId: string, eventName: string) => string;
+/**
+ * event properties
+ */
+export type EventOptions = {
+    /**
+     * unique id of the guest to send the event to
+     */
+    guestId?: string;
+    /**
+     * guest window to send the event to
+     */
+    window?: Window;
+    /**
+     * time in milliseconds to wait for the guest to respond back for the event
+     */
+    timeout?: number;
+    /**
+     * global function that handles the event on the guest
+     */
+    eventHandler?: string;
+};
+/**
+ * parameters for dispatching an event
+ */
+export type DispatchEventParam<EventId, Params, Options extends EventOptions> = {
+    /**
+     * event details
+     */
+    event: {
+        /**
+         * unique id of the event in the format objectId.eventName
+         * @example 'loan.sync'
+         */
+        id: EventId;
+        /**
+         * name of the event
+         * @example 'sync'
+         */
+        name: string;
+        /**
+         * scripting object id that owns this event
+         * @example 'loan'
+         */
+        objectId?: string;
+    };
+    /**
+     * event parameters
+     */
+    eventParams: Params;
+    /**
+     * additional options for the event
+     */
+    eventOptions?: Options;
+};