@0dep/bpmn-extensions 0.0.2 → 0.0.4

package/types/index.d.ts

@@ -18,8 +18,8 @@ declare module '@0dep/bpmn-extensions' {
 	 * A flow extension activated by bpmn-elements around an element's run.
 	 */
 	export type FlowExtension = {
-		activate: (message: any) => void;
-		deactivate: (message?: any) => void;
+		activate: (message: import("bpmn-elements").ElementBrokerMessage) => void;
+		deactivate: (message?: import("bpmn-elements").ElementBrokerMessage) => void;
 	};
 	/**
 	 * FEEL-aware expressions implementation for bpmn-elements.
@@ -29,7 +29,10 @@ declare module '@0dep/bpmn-extensions' {
 	 * `${...}` template expressions.
 	 *
 	 * */
-	export function FeelExpressions(): import("bpmn-elements").IExpressions;
+	export function FeelExpressions(): import("bpmn-elements").IExpressions & {
+		isExpression: (text: string) => boolean;
+		hasExpression: (text: string) => boolean;
+	};
 	/**
 	 * A bpmn-elements `scripts` implementation for script tasks.
 	 *
@@ -75,7 +78,10 @@ declare module '@0dep/bpmn-extensions' {
 		type: string | undefined;
 		taskType: any;
 		activity: any;
-		execute(executionMessage: any, callback: any): any;
+		/**
+		 * Execute
+		 * */
+		execute(executionMessage: import("bpmn-elements").ElementBrokerMessage, callback: CallableFunction): any;
 	}
 	/**
 	 * Activity-level extensions.
@@ -85,29 +91,29 @@ declare module '@0dep/bpmn-extensions' {
 	 * proceeding — the same mechanism bpmn-elements uses for extension formatting.
 	 */
 	export class ElementExtensions {
-		constructor(activity: any);
-		activity: any;
-		formatQ: any;
-		extensions: {
-			format: FormatActivity | FormatProcess;
-			io?: IoMapping;
-			headers?: TaskHeaders;
-			properties?: Properties;
-			listeners?: ExecutionListeners;
-			form?: Form;
-			loop?: LoopCharacteristics;
-			script?: any;
-			calledDecision?: any;
-			Service?: Function;
-		};
-		activate(message: any): void;
+		
+		constructor(activity: import("bpmn-elements").Activity, context: import("bpmn-elements").ContextInstance);
+		activity: import("bpmn-elements").Activity;
+		formatQ: import("smqp").Queue | undefined;
+		
+		extensions: ExtensionHandlers;
+		/**
+		 * Activate extensions
+		 * */
+		activate(message: import("bpmn-elements").ElementBrokerMessage): void;
 		deactivate(): void;
-		/** @internal Shared with SubProcessExtensions. */
-		_onEnter(elementApi: any): Promise<void>;
-		/** @internal Shared with SubProcessExtensions. */
-		_onExecuted(elementApi: any): Promise<void>;
-		/** @internal Shared with SubProcessExtensions. */
-		_onListener(eventType: any, elementApi: any): Promise<void>;
+		/**
+		 * @internal Shared with SubProcessExtensions.
+		 * */
+		_onEnter(elementApi: import("bpmn-elements").IApi<import("bpmn-elements").Activity>): Promise<void>;
+		/**
+		 * @internal Shared with SubProcessExtensions.
+		 * */
+		_onExecuted(elementApi: import("bpmn-elements").IApi<import("bpmn-elements").Activity>): Promise<void>;
+		/**
+		 * @internal Shared with SubProcessExtensions.
+		 * */
+		_onListener(eventType: any, elementApi: import("bpmn-elements").IApi<import("bpmn-elements").Activity>): Promise<void>;
 		#private;
 	}
 	/**
@@ -115,20 +121,11 @@ declare module '@0dep/bpmn-extensions' {
 	 * the result to the process variables.
 	 */
 	export class ProcessExtensions {
-		constructor(bp: any);
-		process: any;
-		extensions: {
-			format: FormatActivity | FormatProcess;
-			io?: IoMapping;
-			headers?: TaskHeaders;
-			properties?: Properties;
-			listeners?: ExecutionListeners;
-			form?: Form;
-			loop?: LoopCharacteristics;
-			script?: any;
-			calledDecision?: any;
-			Service?: Function;
-		};
+		
+		constructor(bp: import("bpmn-elements").Process);
+		process: import("bpmn-elements").Process;
+		
+		extensions: ExtensionHandlers;
 		activate(): void;
 		deactivate(): void;
 		#private;
@@ -143,6 +140,7 @@ declare module '@0dep/bpmn-extensions' {
 	 * sub-process's own id.
 	 */
 	export class SubProcessExtensions extends ElementExtensions {
+		activate(message: any): void;
 		#private;
 	}
 	/**
@@ -164,7 +162,8 @@ declare module '@0dep/bpmn-extensions' {
 	 * @param expression FEEL unary test
 	 * @param input The value being tested, available as `?` in the test
 	 * @param context Additional variables in scope
-	 * */
+	 * @returns true only when the test is satisfied — an undecidable (null) test is false
+	 */
 	export function evaluateFeelUnaryTest(expression: string, input: any, context?: Record<string, any>): boolean;
 	/**
 	 * Resolve a value: evaluate it as FEEL when it starts with `=`, otherwise
@@ -172,6 +171,16 @@ declare module '@0dep/bpmn-extensions' {
 	 * @param context Variables in scope for FEEL evaluation
 	 * */
 	export function resolveValue(value: any, context?: Record<string, any>): any;
+	/**
+	 * Build the FEEL evaluation scope for an environment. The environment services are exposed
+	 * under `services`, callable as FEEL functions (e.g. `services.isEligible(order)`) — resume-safe,
+	 * since the host re-supplies services at recover time, unlike functions smuggled through
+	 * variables, which JSON state serialization drops. The environment variables form the base
+	 * scope, overlaid with any local variables (a job result, element-local variables such as a
+	 * multi-instance item); a variable named `services` shadows the overlay.
+	 * @param localVariables scope-local overlay
+	 * */
+	export function getFeelScope(environment?: import("bpmn-elements").Environment, localVariables?: Record<string, any>): Record<string, any>;
 	export class ServiceError extends Error {
 		constructor(jobType: any);
 		code: string;
@@ -186,15 +195,33 @@ declare module '@0dep/bpmn-extensions' {
 			statusCode: number;
 		};
 	}
+	/**
+	 * The extension handlers assembled for one element.
+	 */
+	type ExtensionHandlers = {
+		format: FormatActivity | FormatProcess;
+		io?: IoMapping | undefined;
+		headers?: TaskHeaders | undefined;
+		properties?: Properties | undefined;
+		listeners?: ExecutionListeners | undefined;
+		form?: Form | undefined;
+		loop?: LoopCharacteristics | undefined;
+		script?: any;
+		calledDecision?: any;
+		Service?: Function | undefined;
+		subscription?: Subscription | undefined;
+	};
 	/**
 	 * Format an activity on enter from its behaviour and extensions: documentation and,
 	 * for user tasks, the `zeebe:assignmentDefinition` (assignee, candidate users/groups).
 	 */
 	class FormatActivity {
-		constructor(activity: any, assignmentDefinition: any);
-		activity: any;
+		
+		constructor(activity: import("bpmn-elements").Activity, assignmentDefinition: any);
+		activity: import("bpmn-elements").Activity;
 		assignmentDefinition: any;
-		resolve(elementApi: any): {
+		
+		resolve(elementApi: import("bpmn-elements").IApi<import("bpmn-elements").Activity>): {
 			description: any;
 			assignee: any;
 			candidateUsers: any[];
@@ -205,9 +232,11 @@ declare module '@0dep/bpmn-extensions' {
 	 * Format a process on enter: documentation.
 	 */
 	class FormatProcess {
-		constructor(bp: any);
-		process: any;
-		resolve(elementApi: any): {
+		
+		constructor(bp: import("bpmn-elements").Process);
+		process: import("bpmn-elements").Process;
+		
+		resolve(elementApi: import("bpmn-elements").IApi<import("bpmn-elements").Process>): {
 			description: any;
 		};
 	}
@@ -319,10 +348,43 @@ declare module '@0dep/bpmn-extensions' {
 		get hasOutputCollection(): boolean;
 		/**
 		 * @param indexedOutput bpmn-elements index-keyed instance outputs
-		 * @param baseScope process variables in scope for `outputElement`
+		 * @param baseScope base scope for `outputElement` (services + process variables)
 		 * */
 		aggregate(indexedOutput: Record<string, any> | undefined, baseScope: Record<string, any>): any[];
 	}
+	/**
+	 * `zeebe:subscription` — rides on the referenced `bpmn:Message`, not on the catching element.
+	 *
+	 * Resolves the correlation key in the activity's variable scope on enter and exposes it on the
+	 * element content as `subscription`. Correlation itself is the embedding application's job:
+	 * read the resolved key off the waiting activity (`getPostponed()` → `content.subscription`)
+	 * and signal the matching one (`api.signal(...)`).
+	 */
+	class Subscription {
+		/**
+		 * @param messageRef The serialized message reference
+		 * @param subscription The `zeebe:Subscription` behaviour
+		 */
+		constructor(messageRef: {
+			id: string;
+			name?: string;
+		}, subscription: {
+			correlationKey: string;
+		});
+		message: {
+			id: string;
+			name: string | undefined;
+		};
+		correlationKey: string;
+		
+		resolve(elementApi: import("bpmn-elements").IApi<any>): {
+			message: {
+				id: string;
+				name?: string;
+			};
+			correlationKey: any;
+		};
+	}
 
 	export {};
 }

package/types/index.d.ts.map

@@ -15,6 +15,7 @@
 		"evaluateFeel",
 		"evaluateFeelUnaryTest",
 		"resolveValue",
+		"getFeelScope",
 		"ServiceError",
 		"FormatError",
 		"FormatActivity",
@@ -24,7 +25,8 @@
 		"Properties",
 		"ExecutionListeners",
 		"Form",
-		"LoopCharacteristics"
+		"LoopCharacteristics",
+		"Subscription"
 	],
 	"sources": [
 		"../src/index.js",
@@ -42,7 +44,8 @@
 		"../src/extensions/Properties.js",
 		"../src/extensions/ExecutionListeners.js",
 		"../src/extensions/Form.js",
-		"../src/extensions/LoopCharacteristics.js"
+		"../src/extensions/LoopCharacteristics.js",
+		"../src/extensions/Subscription.js"
 	],
 	"sourcesContent": [
 		null,
@@ -60,8 +63,9 @@
 		null,
 		null,
 		null,
+		null,
 		null
 	],
-	"mappings": ";;;;;;;iBAwBgBA,UAAUA;;;;;;;;iBAqBVC,QAAQA;;;;;;;;;;;;;;;;iBClCRC,eAAeA;;;;;;;;;;;iBCEfC,WAAWA;;;;;;;;;;;;;;;iBCIXC,UAAUA;cAAVA,UAAUA;;;;;;;;;;;;;;;;;;;;;;;;;;;;cCNbC,iBAAiBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cCJjBC,iBAAiBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;cCIjBC,oBAAoBA;;;;;;iBCEjBC,gBAAgBA;;;;iBAShBC,SAASA;;;;;;iBAUTC,YAAYA;;;;;;;iBAYZC,qBAAqBA;;;;;;iBAYrBC,YAAYA;cCxDfC,YAAYA;;;;;;;cAQZC,WAAWA;;;;;;;;;;;OCFXC,cAAcA;;;;;;;;;;;;;;OAgCdC,aAAaA;;;;;;;;;;;;;;;;;;OCzBbC,SAASA;;;;;;;;;;;;;;;;;;;;;;;OCPTC,WAAWA;;;;;;;;;;;OCEXC,UAAUA;;;;;;;;;;;;;;;OCIVC,kBAAkBA;;;;;;;;;;;;;;;;;;;OCFlBC,IAAIA;;;;;;;;;;;;;;;;;;;;;;OCGJC,mBAAmBA",
+	"mappings": ";;;;;;;iBAwBgBA,UAAUA;;;;;;;;iBAqBVC,QAAQA;;;;;;;;;;;;;;;;iBClCRC,eAAeA;;;;;;;;;;;;;;iBCEfC,WAAWA;;;;;;;;;;;;;;;iBCIXC,UAAUA;cAAVA,UAAUA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cCEbC,iBAAiBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cCZjBC,iBAAiBA;;;;;;;;;;;;;;;;;;;cCIjBC,oBAAoBA;;;;;;;iBCEjBC,gBAAgBA;;;;iBAShBC,SAASA;;;;;;iBAUTC,YAAYA;;;;;;;;iBAYZC,qBAAqBA;;;;;;iBAYrBC,YAAYA;;;;;;;;;;iBAgBZC,YAAYA;cCxEfC,YAAYA;;;;;;;cAQZC,WAAWA;;;;;;;;;;;;;;;;;;;;;;;;;;;OCFXC,cAAcA;;;;;;;;;;;;;;;;OAuCdC,aAAaA;;;;;;;;;;;;;;;;;;;;OChCbC,SAASA;;;;;;;;;;;;;;;;;;;;;;;OCPTC,WAAWA;;;;;;;;;;;OCEXC,UAAUA;;;;;;;;;;;;;;;OCIVC,kBAAkBA;;;;;;;;;;;;;;;;;;;OCFlBC,IAAIA;;;;;;;;;;;;;;;;;;;;;;OCGJC,mBAAmBA;;;;;;;;;;;;;;;;;;;OCHnBC,YAAYA",
 	"ignoreList": []
 }