@elliemae/microfe-common 2.3.1 → 2.4.0

package/dist/cjs/event.js

@@ -47,7 +47,6 @@ class Event {
   id;
   /**
    * Create an event object
-   *
    * @param {EventParam} param - parameters for creating an event
    */
   constructor(param) {

package/dist/cjs/remoting.js

@@ -63,7 +63,6 @@ class Remoting {
   #allowedSenders = /* @__PURE__ */ new Map();
   /**
    * Create a new instance of the Remoting class
-   *
    * @param logger pui-diagnostic logger
    * @param correlationId unique id for the current session
    */
@@ -212,7 +211,6 @@ class Remoting {
   };
   /**
    * Adds window and its origin list of allowed senders
-   *
    * @param {AddSenderParam} param - The sender to add
    */
   addSender = (param) => {
@@ -225,7 +223,6 @@ class Remoting {
   };
   /**
    * Initializes the remoting service for a window
-   *
    * @param win The window to initialize remoting for
    */
   initialize = (win) => {
@@ -242,7 +239,6 @@ class Remoting {
   };
   /**
    * Sends an invocation which generates a Promise to be used to get a response
-   *
    * @param {InvokeParam} param The parameters for the invocation
    * @returns promisifyed response
    */
@@ -277,7 +273,6 @@ class Remoting {
   };
   /**
    * Setup callback for a specific message type
-   *
    * @param {ListenParam<T>} param The parameters for the listener
    */
   listen = (param) => {
@@ -288,7 +283,6 @@ class Remoting {
   };
   /**
    * Send a message without any form of response. Fire and forget
-   *
    * @param {SendParam} param The parameters for the send
    */
   send = (param) => {
@@ -303,7 +297,6 @@ class Remoting {
   };
   /**
    * Removes a window from the list of allowed senders
-   *
    * @param {AddSenderParam} param - The sender to remove
    */
   removeSender = (param) => {
@@ -313,7 +306,6 @@ class Remoting {
   };
   /**
    * Send a response message to a window
-   *
    * @param {RespondParam} param The parameters for the response
    */
   respond = (param) => {
@@ -330,7 +322,6 @@ class Remoting {
   };
   /**
    * Send an exception message to a window
-   *
    * @param {RaiseExceptionParam} param The parameters for the exception
    */
   raiseException = (param) => {

package/dist/cjs/scriptingObject.js

@@ -35,7 +35,6 @@ class ScriptingObject {
   #objectType = "Object";
   /**
    * Creates an instance of ScriptingObject.
-   *
    * @param objectId unique id of the scripting object
    * @param objectType type of the scripting object
    */
@@ -57,7 +56,6 @@ class ScriptingObject {
   }
   /**
    * transform the scripting object to a format suitable for transmitting over window.postMessage
-   *
    * @returns marshalled scripting object
    */
   // eslint-disable-next-line no-underscore-dangle

package/dist/cjs/scriptingObjectManager.js

@@ -96,7 +96,6 @@ class ScriptingObjectManager {
   };
   /**
    * attach guest context to the scripting object methods
-   *
    * @param root0
    * @param root0.so
    * @param root0.guest
@@ -124,7 +123,6 @@ class ScriptingObjectManager {
   });
   /**
    * registers scripting object to the host
-   *
    * @param so scripting object to register
    * @param {AddScriptingObjectParams<ValueOf<AppObjects>>}
    * @param params
@@ -148,7 +146,6 @@ class ScriptingObjectManager {
   };
   /**
    * 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
@@ -179,7 +176,6 @@ class ScriptingObjectManager {
   };
   /**
    * removes scripting object
-   *
    * @param objectId unique id of the scripting object
    * @param guestId unique id of the guest
    */
@@ -197,7 +193,6 @@ class ScriptingObjectManager {
   };
   /**
    * removes all scripting objects
-   *
    * @param guestId unique id of the guest
    */
   removeAllScriptingObjects = (guestId) => {

package/dist/esm/event.js

@@ -22,7 +22,6 @@ class Event {
   id;
   /**
    * Create an event object
-   *
    * @param {EventParam} param - parameters for creating an event
    */
   constructor(param) {

package/dist/esm/remoting.js

@@ -39,7 +39,6 @@ class Remoting {
   #allowedSenders = /* @__PURE__ */ new Map();
   /**
    * Create a new instance of the Remoting class
-   *
    * @param logger pui-diagnostic logger
    * @param correlationId unique id for the current session
    */
@@ -188,7 +187,6 @@ class Remoting {
   };
   /**
    * Adds window and its origin list of allowed senders
-   *
    * @param {AddSenderParam} param - The sender to add
    */
   addSender = (param) => {
@@ -201,7 +199,6 @@ class Remoting {
   };
   /**
    * Initializes the remoting service for a window
-   *
    * @param win The window to initialize remoting for
    */
   initialize = (win) => {
@@ -218,7 +215,6 @@ class Remoting {
   };
   /**
    * Sends an invocation which generates a Promise to be used to get a response
-   *
    * @param {InvokeParam} param The parameters for the invocation
    * @returns promisifyed response
    */
@@ -253,7 +249,6 @@ class Remoting {
   };
   /**
    * Setup callback for a specific message type
-   *
    * @param {ListenParam<T>} param The parameters for the listener
    */
   listen = (param) => {
@@ -264,7 +259,6 @@ class Remoting {
   };
   /**
    * Send a message without any form of response. Fire and forget
-   *
    * @param {SendParam} param The parameters for the send
    */
   send = (param) => {
@@ -279,7 +273,6 @@ class Remoting {
   };
   /**
    * Removes a window from the list of allowed senders
-   *
    * @param {AddSenderParam} param - The sender to remove
    */
   removeSender = (param) => {
@@ -289,7 +282,6 @@ class Remoting {
   };
   /**
    * Send a response message to a window
-   *
    * @param {RespondParam} param The parameters for the response
    */
   respond = (param) => {
@@ -306,7 +298,6 @@ class Remoting {
   };
   /**
    * Send an exception message to a window
-   *
    * @param {RaiseExceptionParam} param The parameters for the exception
    */
   raiseException = (param) => {

package/dist/esm/scriptingObject.js

@@ -12,7 +12,6 @@ class ScriptingObject {
   #objectType = "Object";
   /**
    * Creates an instance of ScriptingObject.
-   *
    * @param objectId unique id of the scripting object
    * @param objectType type of the scripting object
    */
@@ -34,7 +33,6 @@ class ScriptingObject {
   }
   /**
    * transform the scripting object to a format suitable for transmitting over window.postMessage
-   *
    * @returns marshalled scripting object
    */
   // eslint-disable-next-line no-underscore-dangle

package/dist/esm/scriptingObjectManager.js

@@ -72,7 +72,6 @@ class ScriptingObjectManager {
   };
   /**
    * attach guest context to the scripting object methods
-   *
    * @param root0
    * @param root0.so
    * @param root0.guest
@@ -100,7 +99,6 @@ class ScriptingObjectManager {
   });
   /**
    * registers scripting object to the host
-   *
    * @param so scripting object to register
    * @param {AddScriptingObjectParams<ValueOf<AppObjects>>}
    * @param params
@@ -124,7 +122,6 @@ class ScriptingObjectManager {
   };
   /**
    * 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
@@ -155,7 +152,6 @@ class ScriptingObjectManager {
   };
   /**
    * removes scripting object
-   *
    * @param objectId unique id of the scripting object
    * @param guestId unique id of the guest
    */
@@ -173,7 +169,6 @@ class ScriptingObjectManager {
   };
   /**
    * removes all scripting objects
-   *
    * @param guestId unique id of the guest
    */
   removeAllScriptingObjects = (guestId) => {

package/dist/types/event.d.ts

@@ -60,21 +60,18 @@ export declare class Event<EventsList extends EventListeners = Events> implement
     readonly id: Extract<keyof EventsList, string>;
     /**
      * Create an event object
-     *
      * @param {EventParam} param - parameters for creating an event
      */
     constructor(param: EventParam);
 }
 /**
  * Check given object is an event
- *
  * @param value object to check
  * @returns true if given object is an event
  */
 export declare const isEvent: (value: any) => value is Event<Events>;
 /**
  * Get normalized event ID for an object and event
- *
  * @param objectId scripting object id
  * @param eventName  event name
  * @returns normalized event ID

package/dist/types/guest.d.ts

@@ -42,7 +42,6 @@ export type UnsubscribeParam<EventId> = {
 export interface ISSFGuest<AppEvents extends EventListeners> {
     /**
      * Initialize guest using script
-     *
      * @param scriptUri uri of the script
      * @param containerElement dom element to inject the script at
      */
@@ -53,13 +52,11 @@ export interface ISSFGuest<AppEvents extends EventListeners> {
     close: () => void;
     /**
      * Connect to the host
-     *
      * @param {ConnectParam} param - reference to the guest window or parameters
      */
     connect: (param?: ConnectParam) => Promise<void>;
     /**
      * Get scripting object proxy by id
-     *
      * @param objectId unique id of the scripting object
      * @returns scripting object proxy
      */
@@ -70,20 +67,17 @@ export interface ISSFGuest<AppEvents extends EventListeners> {
     removeScript: () => void;
     /**
      * set the log level
-     *
      * @param {LogLevels} logLevel - log level
      */
     setLogLevel: (logLevel: LogLevels) => void;
     /**
      * 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;

package/dist/types/remoting.d.ts

@@ -152,7 +152,6 @@ export type RaiseExceptionParam = {
 };
 /**
  * Sends a message to another window
- *
  * @param {SendParam} param - parameters for sending the message
  */
 export declare const sendMessage: (param: SendParam) => void;
@@ -176,20 +175,17 @@ export declare class Remoting {
     #private;
     /**
      * Create a new instance of the Remoting class
-     *
      * @param logger pui-diagnostic logger
      * @param correlationId unique id for the current session
      */
     constructor(logger: Logger, correlationId: string);
     /**
      * Adds window and its origin list of allowed senders
-     *
      * @param {AddSenderParam} param - The sender to add
      */
     addSender: (param: AddSenderParam) => void;
     /**
      * Initializes the remoting service for a window
-     *
      * @param win The window to initialize remoting for
      */
     initialize: (win: Window) => void;
@@ -199,38 +195,32 @@ export declare class Remoting {
     close: () => void;
     /**
      * Sends an invocation which generates a Promise to be used to get a response
-     *
      * @param {InvokeParam} param The parameters for the invocation
      * @returns promisifyed response
      */
     invoke: <T>(param: InvokeParam) => Promise<T>;
     /**
      * Setup callback for a specific message type
-     *
      * @param {ListenParam<T>} param The parameters for the listener
      */
     listen: <T>(param: ListenParam<T>) => void;
     /**
      * Send a message without any form of response. Fire and forget
-     *
      * @param {SendParam} param The parameters for the send
      */
     send: (param: SendParam) => void;
     /**
      * Removes a window from the list of allowed senders
-     *
      * @param {AddSenderParam} param - The sender to remove
      */
     removeSender: (param: AddSenderParam) => void;
     /**
      * Send a response message to a window
-     *
      * @param {RespondParam} param The parameters for the response
      */
     respond: (param: RespondParam) => void;
     /**
      * Send an exception message to a window
-     *
      * @param {RaiseExceptionParam} param The parameters for the exception
      */
     raiseException: (param: RaiseExceptionParam) => void;

package/dist/types/scriptingObject.d.ts

@@ -7,7 +7,6 @@ export declare class ScriptingObject implements IScriptingObject {
     #private;
     /**
      * Creates an instance of ScriptingObject.
-     *
      * @param objectId unique id of the scripting object
      * @param objectType type of the scripting object
      */
@@ -22,7 +21,6 @@ export declare class ScriptingObject implements IScriptingObject {
     get objectType(): string;
     /**
      * transform the scripting object to a format suitable for transmitting over window.postMessage
-     *
      * @returns marshalled scripting object
      */
     _toJSON: () => RemotingScriptingObject;

package/dist/types/scriptingObjectManager.d.ts

@@ -66,7 +66,6 @@ export declare class ScriptingObjectManager<AppObjects extends ScriptingObjects
     #private;
     /**
      * registers scripting object to the host
-     *
      * @param so scripting object to register
      * @param {AddScriptingObjectParams<ValueOf<AppObjects>>}
      * @param params
@@ -74,7 +73,6 @@ export declare class ScriptingObjectManager<AppObjects extends ScriptingObjects
     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
@@ -82,14 +80,12 @@ export declare class ScriptingObjectManager<AppObjects extends ScriptingObjects
     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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/microfe-common",
-  "version": "2.3.1",
+  "version": "2.4.0",
   "description": "common micro frontend functional modules",
   "repository": {
     "type": "git",
@@ -39,7 +39,7 @@
   "devDependencies": {
     "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.8.0",
     "@elliemae/pui-diagnostics": "~3.4.1",
-    "@elliemae/pui-scripting-object": "~1.31.1",
+    "@elliemae/pui-scripting-object": "~1.31.3",
     "@types/uuid": "~9.0.7"
   },
   "scripts": {