@kizenapps/engine 1.5.2-065350b → 1.6.0

package/README.md

@@ -197,3 +197,7 @@ const ScriptButton = ({ pluginScript }: { pluginScript: string }) => {
 #### Worker Runner
 
 Some worker calls are coordinated using `@tanstack/react-query`. If your consumer app also uses react-query, the app engine will use your existing query provider. If you aren't already using react-query, the engine provider will be wrapped in its own query context and no additional action is needed.
+
+### Script Return Values
+
+Scripts can return values from the worker thread. Awaiting the execute function returned from a plugin runner script will yield the value that the worker thread returned.

package/dist/{ThirdPartyScript-DVgjFFyS.d.ts → ThirdPartyScript-CvOXQBiO.d.ts}

@@ -403,6 +403,7 @@ declare const ACTIONS: {
     SHOW_VIEW_IN_MODAL_REQUEST: string;
     CLOSE_MODAL_REQUEST: string;
     CONSOLE_LOG: string;
+    RUN_EVENT_SCRIPT: string;
 };
 declare enum INDICATOR_TYPE {
     NONE = "none",

package/dist/{automation-CRWtgS0X.d.ts → automation-ez9zQ2sv.d.ts}

@@ -1,4 +1,4 @@
-import { b2 as ACTIONS, U as UnknownJSON, b3 as ALLOWED_INTEGRATIONS, J as ConsoleLogLevel, M as ModalConfig, S as StateChangePayload, k as ShowToastOptions, h as InternalSessionData, l as ShowViewInModalOptions, aT as SetInternalSessionDataFn, aB as OnShowModalFn, az as OnShowCreateRecordModalFn, aA as OnShowCreateRelatedRecordModalFn, ax as OnCloseModalFn, ay as OnNetworkErrorFn, W as WorkerContextArgs, a7 as EmployeeConfig } from './ThirdPartyScript-DVgjFFyS.js';
+import { b2 as ACTIONS, U as UnknownJSON, b3 as ALLOWED_INTEGRATIONS, J as ConsoleLogLevel, M as ModalConfig, S as StateChangePayload, k as ShowToastOptions, h as InternalSessionData, l as ShowViewInModalOptions, aT as SetInternalSessionDataFn, aB as OnShowModalFn, az as OnShowCreateRecordModalFn, aA as OnShowCreateRelatedRecordModalFn, ax as OnCloseModalFn, ay as OnNetworkErrorFn, W as WorkerContextArgs, a7 as EmployeeConfig } from './ThirdPartyScript-CvOXQBiO.js';
 import { H as HideConfig, S as ShowConfig } from './floatingFrames-BzaoL7cq.js';
 
 interface CommonPluginDefinition {
@@ -57,6 +57,7 @@ interface RunScriptOptions {
     getPendingCacheCount?: GetPendingCacheCountFn | undefined;
     invalidateCache?: InvalidateCacheFn | undefined;
     onConsoleLog?: OnConsoleLogFn;
+    onRunEventScript?: OnRunEventScriptFn;
 }
 type RequestableQueryMethods = 'get' | 'post' | 'patch' | 'delete';
 type OnNetworkRequestFn = (method: RequestableQueryMethods, url: string, payload?: UnknownJSON, options?: UnknownJSON) => Promise<{
@@ -188,8 +189,13 @@ interface ConsoleLogEvent extends BaseEvent {
     level: ConsoleLogLevel;
     args: unknown[];
 }
+interface RunEventScriptEvent extends BaseEvent {
+    scriptName: string;
+    args?: UnknownJSON;
+}
 type OnConsoleLogFn = (level: ConsoleLogLevel, args: unknown[]) => void;
-type MessageEventData = QueryRequestEvent | UIOutputEvent | IframeOutputEvent | PostFormDataRequestEvent | UploadFileRequestEvent | SetStateEvent | DoneEvent | ErrorEvent | OpenWindowEvent | CommunicateEvent | HideEvent | ShowEvent | CopyToClipboardEvent | OpenCreateRecordModalRequestEvent | OpenCreateRelatedRecordModalRequestEvent | ShowToastEvent | RefreshTimelineEvent | RefreshEntityEvent | UpdateSessionDataEvent | InstallThirdPartyScriptRequestEvent | PromptRequestEvent | DynamicPromptRequestEvent | ShowViewInModalRequestEvent | CloseModalRequestEvent | AuthorizeEvent | ConsoleLogEvent;
+type OnRunEventScriptFn = (scriptName: string, args?: UnknownJSON) => void;
+type MessageEventData = QueryRequestEvent | UIOutputEvent | IframeOutputEvent | PostFormDataRequestEvent | UploadFileRequestEvent | SetStateEvent | DoneEvent | ErrorEvent | OpenWindowEvent | CommunicateEvent | HideEvent | ShowEvent | CopyToClipboardEvent | OpenCreateRecordModalRequestEvent | OpenCreateRelatedRecordModalRequestEvent | ShowToastEvent | RefreshTimelineEvent | RefreshEntityEvent | UpdateSessionDataEvent | InstallThirdPartyScriptRequestEvent | PromptRequestEvent | DynamicPromptRequestEvent | ShowViewInModalRequestEvent | CloseModalRequestEvent | AuthorizeEvent | ConsoleLogEvent | RunEventScriptEvent;
 type InvalidateCacheFn = (category: 'timeline' | 'entity', entityId: string) => void;
 type GetPendingCacheCountFn = (search: string) => number;
 interface KizenFile extends File {
@@ -285,7 +291,7 @@ interface FloatingFrameConfig extends CommonPluginDefinition {
     employee_config?: EmployeeConfig<FloatingFrameEmployeeConfig>;
     args?: Record<string, UnknownJSON>;
 }
-type ExecuteFloatingFrameScript = (script: string, args?: Record<string, unknown>) => void;
+type ExecuteFloatingFrameScript = (script: string, args?: Record<string, unknown>) => Promise<unknown>;
 
 interface RoutablePageConfig extends CommonPluginDefinition {
     api_name: string;
@@ -350,4 +356,4 @@ interface AutomationStepConfig<T = unknown> {
     plugin_api_name?: string;
 }
 
-export type { ShowEvent as $, AutomationStepConfig as A, BaseEvent as B, CommonExecutionPlugin as C, DataAdornmentConfig as D, ErrorEvent as E, FloatingFrameConfig as F, GetPendingCacheCountFn as G, HideEvent as H, IframeOutputEvent as I, OpenCreateRecordModalRequestEvent as J, KizenFile as K, OpenCreateRelatedRecordModalRequestEvent as L, MessageEventData as M, OpenWindowEvent as N, OnClearToastsFn as O, PerformKizenFileUploadFn as P, PostFormDataRequestEvent as Q, RoutablePageConfig as R, PromptRequestEvent as S, ToolbarItemConfig as T, QueryRequestEvent as U, RecipientConfig as V, RefreshEntityEvent as W, RefreshTimelineEvent as X, RequestableQueryMethods as Y, SchemaValidation as Z, SetStateEvent as _, CommonPluginDefinition as a, ShowToastEvent as a0, ShowViewInModalRequestEvent as a1, TerminatorContent as a2, Terminators as a3, UIOutputEvent as a4, UpdateSessionDataEvent as a5, UploadFilePayload as a6, UploadFileRequestEvent as a7, WindowPosition as a8, RouteScriptConfig as b, CalendarSourceConfig as c, RunScriptOptions as d, AuthorizeEvent as e, CalendarDefinition as f, CalendarScriptReturnData as g, CalendarSourceMap as h, CalendarSources as i, CloseModalRequestEvent as j, CommunicateEvent as k, ConsoleLogEvent as l, CopyToClipboardEvent as m, CreateFileIdFn as n, DoneEvent as o, DynamicPromptRequestEvent as p, ExecuteCalendarSourceScript as q, ExecuteFloatingFrameScript as r, FloatingFrameEmployeeConfig as s, FrameQuadrant as t, InstallThirdPartyScriptRequestEvent as u, InvalidateCacheFn as v, MinimizedConfig as w, OnConsoleLogFn as x, OnNetworkRequestFn as y, OnShowToastFn as z };
+export type { SchemaValidation as $, AutomationStepConfig as A, BaseEvent as B, CommonExecutionPlugin as C, DataAdornmentConfig as D, ErrorEvent as E, FloatingFrameConfig as F, GetPendingCacheCountFn as G, HideEvent as H, IframeOutputEvent as I, OnShowToastFn as J, KizenFile as K, OpenCreateRecordModalRequestEvent as L, MessageEventData as M, OpenCreateRelatedRecordModalRequestEvent as N, OnClearToastsFn as O, OpenWindowEvent as P, PerformKizenFileUploadFn as Q, RoutablePageConfig as R, PostFormDataRequestEvent as S, ToolbarItemConfig as T, PromptRequestEvent as U, QueryRequestEvent as V, RecipientConfig as W, RefreshEntityEvent as X, RefreshTimelineEvent as Y, RequestableQueryMethods as Z, RunEventScriptEvent as _, CommonPluginDefinition as a, SetStateEvent as a0, ShowEvent as a1, ShowToastEvent as a2, ShowViewInModalRequestEvent as a3, TerminatorContent as a4, Terminators as a5, UIOutputEvent as a6, UpdateSessionDataEvent as a7, UploadFilePayload as a8, UploadFileRequestEvent as a9, WindowPosition as aa, RouteScriptConfig as b, CalendarSourceConfig as c, RunScriptOptions as d, AuthorizeEvent as e, CalendarDefinition as f, CalendarScriptReturnData as g, CalendarSourceMap as h, CalendarSources as i, CloseModalRequestEvent as j, CommunicateEvent as k, ConsoleLogEvent as l, CopyToClipboardEvent as m, CreateFileIdFn as n, DoneEvent as o, DynamicPromptRequestEvent as p, ExecuteCalendarSourceScript as q, ExecuteFloatingFrameScript as r, FloatingFrameEmployeeConfig as s, FrameQuadrant as t, InstallThirdPartyScriptRequestEvent as u, InvalidateCacheFn as v, MinimizedConfig as w, OnConsoleLogFn as x, OnNetworkRequestFn as y, OnRunEventScriptFn as z };

package/dist/{chunk-N2EE7JZP.js → chunk-3GJVC5NN.js}

@@ -1,6 +1,6 @@
-import { getPartialLocation, generateUUIDV4 } from './chunk-MLEJMH2T.js';
-import { getAllNestedInputsFromConfig, deserializeConsoleArg, KizenRequestError } from './chunk-SBGLMAOP.js';
-import { IFRAME_PREFIX, ACTIONS, RESPONSES, COMMUNICATIONS, thirdPartyGlobalNames, getScriptIntegrationType, thirdPartySetupScripts, thirdPartyReadyPredicates } from './chunk-KWHKLJVW.js';
+import { getPartialLocation, generateUUIDV4 } from './chunk-3RZHGFVE.js';
+import { getAllNestedInputsFromConfig, deserializeConsoleArg, KizenRequestError } from './chunk-OMIBO27E.js';
+import { IFRAME_PREFIX, ACTIONS, RESPONSES, COMMUNICATIONS, thirdPartyGlobalNames, getScriptIntegrationType, thirdPartySetupScripts, thirdPartyReadyPredicates } from './chunk-BJBB73QA.js';
 import { __commonJS, __toESM } from './chunk-5WRI5ZAA.js';
 import DOMPurify from 'dompurify';
 
@@ -1829,6 +1829,8 @@ var WorkerManager = class {
   pushHistory;
   appPath;
   onConsoleLog;
+  onRunEventScript;
+  isDebug;
   constructor(args) {
     this.scriptUIRef = args.scriptUIRef;
     this.onStateChange = args.onStateChange;
@@ -1855,6 +1857,8 @@ var WorkerManager = class {
     this.pushHistory = args.pushHistory;
     this.appPath = args.appPath;
     this.onConsoleLog = args.onConsoleLog;
+    this.onRunEventScript = args.onRunEventScript;
+    this.isDebug = args.isDebug ?? false;
     if (this.plugin) {
       this.frameId = `${IFRAME_PREFIX}-${this.plugin.plugin_api_name}-${this.plugin.api_name}`;
     }
@@ -2091,6 +2095,14 @@ var WorkerManager = class {
         }
         return;
       }
+      case ACTIONS.RUN_EVENT_SCRIPT: {
+        const consideredEvent = event;
+        this.onRunEventScript?.(consideredEvent.scriptName, consideredEvent.args);
+        if (!this.onRunEventScript && this.isDebug) {
+          console.warn(`No handler for RUN_EVENT_SCRIPT: ${consideredEvent.scriptName}`);
+        }
+        return;
+      }
       default:
         return;
     }
@@ -2520,7 +2532,8 @@ var runScript = async ({
   performFileUpload,
   getPendingCacheCount,
   invalidateCache,
-  onConsoleLog
+  onConsoleLog,
+  onRunEventScript
 }) => {
   const isDebug = isFlagEnabled("script-runner-logging");
   let worker;
@@ -2598,7 +2611,9 @@ var runScript = async ({
       performFileUpload,
       getPendingCacheCount,
       invalidateCache,
-      onConsoleLog
+      onConsoleLog,
+      onRunEventScript,
+      isDebug
     });
     setLoadingState(true);
     instance.run(
@@ -2655,8 +2670,8 @@ var modalSize = {
 };
 
 // src/index.ts
-var version = "1.5.2-065350b";
+var version = "1.6.0";
 
 export { forceQualifiedUrl, getDisabledValue, getEnabledState, getHash, getLinkValue, getPluginSafeHTML, getQrCodeValue, getStableHash, isFlagEnabled, mergeConfig, modalSize, pluginMapper, reduceEnabledResults, replaceConfigValues, runExpression, runObjectExpression, runOptionExpression, runScript, runStringExpression, version };
-//# sourceMappingURL=chunk-N2EE7JZP.js.map
-//# sourceMappingURL=chunk-N2EE7JZP.js.map
+//# sourceMappingURL=chunk-3GJVC5NN.js.map
+//# sourceMappingURL=chunk-3GJVC5NN.js.map