Merge pull request #58 from antmendoza/support-creation-produceeventdef

Support creation produceeventdef

Author: tsurdilo

spec/produce-event-def-builder.spec.ts

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2021-Present The Serverless Workflow Specification Authors
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+import {ProduceEventDefBuilder} from '../src/model/produce-event-def.builder';
+
+
+describe("ProduceEventDefBuilder", () => {
+	
+	it("should throws an error if mandatory fields are not set ", () => {
+		
+		expect(() => new ProduceEventDefBuilder()
+			.build()).toThrowError();
+		
+		expect(() => new ProduceEventDefBuilder()
+			.withEventRef("").build())
+			.toThrowError();
+	});
+	
+	it("should build a valid ProduceEventDef object ", () => {
+		
+		expect(new ProduceEventDefBuilder()
+			.withEventRef("ConfirmationCompletedEvent")
+			.withData("${ .payment }")
+			.withContextAttributes({
+				kContext: "kcValue",
+			})
+			.build())
+			.toEqual({
+				eventRef: "ConfirmationCompletedEvent",
+				data: "${ .payment }",
+				contextAttributes: {
+					kContext: "kcValue",
+				},
+			});
+	});
+	
+	
+});
+

src/index.ts

@@ -27,6 +27,7 @@ export {FunctionBuilder} from "./model/function.builder";
 export {FunctionRefImplBuilder} from "./model/function-ref-impl.builder";
 export {InjectStateBuilder} from "./model/inject-state.builder";
 export {OperationStateBuilder} from "./model/operation-state.builder";
+export {ProduceEventDefBuilder} from "./model/produce-event-def.builder";
 export {RepeatBuilder} from "./model/repeat.builder";
 export {ScheduleBuilder} from "./model/schedule.builder";
 export {SubFlowStateBuilder} from "./model/sub-flow-state.builder";

src/model/produce-event-def.builder.ts

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2021-Present The Serverless Workflow Specification Authors
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+import {EventData, EventName, ProduceEventDef} from '../index';
+
+export class ProduceEventDefBuilder {
+	// @ts-ignore
+	private readonly model: ProduceEventDef = {};
+	
+	
+	withEventRef(value: EventName): ProduceEventDefBuilder {
+		this.model.eventRef = value;
+		return this;
+	}
+	
+	withData(value: EventData): ProduceEventDefBuilder {
+		this.model.data = value;
+		return this;
+		
+	}
+	
+	withContextAttributes(value: object): any {
+		this.model.contextAttributes = value;
+		return this;
+	}
+	
+	build(): ProduceEventDef {
+		if (!this.model.eventRef) {
+			throw new Error("Field eventRef can not be undefined");
+		}
+		return this.model;
+	}
+	
+}

src/model/types.ts

@@ -60,13 +60,11 @@ export  type EventRefType = {
 	/**
 	 * If string type, an expression which selects parts of the states data output to become the data (payload) of the event referenced by 'triggerEventRef'. If object type, a custom object to become the data (payload) of the event referenced by 'triggerEventRef'.
 	 */
-	data?:
-		| string
-		| object;
+	data?: EventData;
 	/**
 	 * Add additional extension context attributes to the produced event
 	 */
-	contextAttributes?: object;
+	contextAttributes?: ContextAttributes;
 };
 
 export type ActionDataFilterType = {
@@ -175,26 +173,7 @@ export type EndType = | boolean
 	/**
 	 * Defines events that should be produced
 	 */
-	produceEvents?: {
-		/**
-		 * References a name of a defined event
-		 */
-		eventRef: string;
-		/**
-		 * If String, expression which selects parts of the states data output to become the data of the produced event. If object a custom object to become the data of produced event.
-		 */
-		data?:
-			| string
-			| {
-			[k: string]: unknown;
-		};
-		/**
-		 * Add additional event extension context attributes
-		 */
-		contextAttributes?: {
-			[k: string]: string;
-		};
-	}[];
+	produceEvents?: ProduceEventsDef;
 	/**
 	 * If set to true, triggers workflow compensation. Default is false
 	 */
@@ -359,3 +338,29 @@ export type CronDef =
 	validUntil?: string;
 };
 export type Interval = string;
+
+export type ExpressionExtractData = string;
+
+export type DataObject = object;
+
+export type EventData =
+	| ExpressionExtractData
+	| DataObject;
+
+export type ContextAttributes = object;
+
+export type ProduceEventDef = {
+	/**
+	 * References a name of a defined event
+	 */
+	eventRef: EventName;
+	/**
+	 * If String, expression which selects parts of the states data output to become the data of the produced event. If object a custom object to become the data of produced event.
+	 */
+	data?: EventData;
+	/**
+	 * Add additional event extension context attributes
+	 */
+	contextAttributes?: ContextAttributes;
+};
+export type ProduceEventsDef = ProduceEventDef[];