@elliemae/microfe-common 2.9.9 → 2.16.5

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

@@ -1,6 +1,7 @@
 import { ScriptingObjectTypes, Events } from '@elliemae/pui-scripting-object';
 import { LogLevels } from '@elliemae/pui-diagnostics';
-import { EventListeners, Listener } from './common.js';
+import { EventListeners } from './common.js';
+import { IEventManager } from './event.js';
 import { ScriptingObjects } from './scriptingObjectManager.js';
 /**
  * parameters for connecting to the host
@@ -11,36 +12,10 @@ export type ConnectParam = {
      */
     window?: Window;
 } & Record<string, any>;
-/**
- * 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;
-};
 /**
  * Interface for SSF guest
  */
-export interface ISSFGuest<AppObjects extends ScriptingObjects = Partial<ScriptingObjectTypes>, AppEvents extends EventListeners = Events> {
+export interface ISSFGuest<AppObjects extends ScriptingObjects = Partial<ScriptingObjectTypes>, AppEvents extends EventListeners = Events> extends IEventManager<AppEvents> {
     /**
      * Initialize guest using script
      * @param scriptUri uri of the script
@@ -67,6 +42,11 @@ export interface ISSFGuest<AppObjects extends ScriptingObjects = Partial<Scripti
      * @returns scripting object proxy
      */
     getObject: <Id extends Extract<keyof AppObjects, string>>(objectId: Id) => Promise<AppObjects[Id]>;
+    /**
+     * Get names of scripting objects exposed by the host
+     * @returns scripting objects exposed by the host
+     */
+    listObjects: () => Promise<keyof AppObjects>;
     /**
      * remove the guest from the host
      */
@@ -76,15 +56,4 @@ export interface ISSFGuest<AppObjects extends ScriptingObjects = Partial<Scripti
      * @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/lib/index.d.ts

@@ -2,11 +2,13 @@ export { Remoting, sendMessage } from './remoting.js';
 export type { ListenerCallback, ListenerCallbackParams, ListenParam, InvokeParam, RaiseExceptionParam, RespondParam, SendParam, AddSenderParam, } from './remoting.js';
 export type { RemotingEventMessage } from './remotingEventMessage.js';
 export { getEventId, ProxyEvent } from './event.js';
-export type { IScriptingObjectProxyEvent, EventParam } from './event.js';
+export type { IScriptingObjectProxyEvent, EventParam, DispatchEventParam, EventOptions, SubscribeParam, UnsubscribeParam, IEventManager, } from './event.js';
 export { Event } from './event.js';
-export { ScriptingObject } from './scriptingObject.js';
+export { ScriptingObject, isPublicFunction } from './scriptingObject.js';
+export type { ScriptingObjects } 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 type { ISSFGuest, ConnectParam } from './guest.js';
 export { ScriptingObjectManager } from './scriptingObjectManager.js';
 export type { AddScriptingObjectParams, GetObjectParams, GuestContext, } from './scriptingObjectManager.js';
+export { ScriptingObjectProxy, isScriptingObjectProxy } from './proxy.js';

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

@@ -1,14 +1,15 @@
 export declare enum MessageType {
-    GuestReady = "guest:ready",
     GuestClose = "guest:close",
+    GuestFocus = "guest:focus",
+    GuestReady = "guest:ready",
     GuestReadyComplete = "guest:readyComplete",
     GuestResize = "guest:resize",
-    GuestFocus = "guest:focus",
     HandShake = "handshake",
     HandShakeAck = "handshake:ack",
-    ObjectInvoke = "object:invoke",
-    ObjectGet = "object:get",
-    ObjectEvent = "object:event",
+    HostClose = "host:close",
     HostConfig = "host:config",
-    HostClose = "host:close"
+    ListObjects = "list:objects",
+    ObjectEvent = "object:event",
+    ObjectGet = "object:get",
+    ObjectInvoke = "object:invoke"
 }

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

@@ -0,0 +1,25 @@
+import type { IScriptingObjectProxy } from '@elliemae/pui-scripting-object';
+/**
+ * Scripting Object Proxy implementation
+ */
+export declare class ScriptingObjectProxy implements IScriptingObjectProxy {
+    /**
+     * proxy type
+     */
+    readonly __TYPE__ = "Proxy";
+    /**
+     * unique id of scripting object
+     */
+    readonly id: string;
+    /**
+     * type of scripting object
+     */
+    readonly objectType: string;
+    /**
+     * Creates a new instance of the Scripting Object Proxy
+     * @param objectId unique id of scripting object
+     * @param objectType type of scripting object
+     */
+    constructor(objectId: string, objectType: string);
+}
+export declare const isScriptingObjectProxy: (value: any) => value is IScriptingObjectProxy;

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

@@ -1,5 +1,6 @@
 import type { RemotingScriptingObject, IScriptingObject } from '@elliemae/pui-scripting-object';
 export type GenericFunction = (...args: unknown[]) => unknown;
+export declare const isPublicFunction: (value: any, fnName: string) => value is GenericFunction;
 /**
  * Base class for all scripting objects
  */
@@ -33,3 +34,8 @@ export declare class ScriptingObject implements IScriptingObject {
      */
     dispose: () => void;
 }
+/**
+ *
+ * collection of scripting objects
+ */
+export type ScriptingObjects = Record<string, IScriptingObject>;

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

@@ -79,6 +79,12 @@ export declare class ScriptingObjectManager<AppObjects extends ScriptingObjects
      * @returns proxied scripting object reference
      */
     getObject: <ObjectId extends Extract<keyof AppObjects, string>>(objectId: ObjectId, guest?: GuestContext) => AppObjects[ObjectId] | null;
+    /**
+     * 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: string) => Extract<keyof AppObjects, string>[];
     /**
      * removes scripting object
      * @param objectId unique id of the scripting object