Support the creation of 'eventRef' object

Signed-off-by: Antonio Mendoza Pérez <[email protected]>

Author: antmendoza

spec/event-ref-builder.spec.ts

@@ -0,0 +1,67 @@
+/*
+ * 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 {EventRefBuilder} from '../src/model/event-ref.builder';
+
+
+describe("event ref builder", () => {
+	
+	
+	it("should create an object with the required fields ", () => {
+		
+		expect(new EventRefBuilder()
+			.withResultEventRef("resultValue")
+			.withTriggerEventRef("triggerValue")
+			.build()).toEqual(
+			{resultEventRef: "resultValue", triggerEventRef: 'triggerValue'},
+		);
+		
+	});
+	
+	
+	it("should create an object with all possible fields ", () => {
+		
+		expect(new EventRefBuilder()
+			.withResultEventRef("resultValue")
+			.withTriggerEventRef("triggerValue")
+			.withContextAttributes({key: "valuect"})
+			.withData({key: "valuedata"})
+			.build()).toEqual(
+			{
+				resultEventRef: "resultValue",
+				triggerEventRef: 'triggerValue',
+				contextAttributes: {key: "valuect"},
+				data: {key: "valuedata"},
+			},
+		);
+	});
+	
+	
+	it("should throws an error if mandatory fields are not set ", () => {
+		
+		expect(() => new EventRefBuilder().build()).toThrowError();
+		
+		expect(() => new EventRefBuilder()
+			.withResultEventRef("").build())
+			.toThrowError();
+		
+		expect(() => new EventRefBuilder()
+			.withTriggerEventRef("")
+			.build()).toThrowError();
+		
+	});
+	
+});

src/model/event-ref.builder.ts

@@ -0,0 +1,59 @@
+<<<<<<< HEAD
+/*
+ * 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 {EventRefType} from '../index';
+
+export class EventRefBuilder {
+	
+	// @ts-ignore
+	private readonly model: EventRefType = {};
+	
+	
+	withResultEventRef(value: string): EventRefBuilder {
+		this.model.resultEventRef = value;
+		return this;
+	}
+	
+	withTriggerEventRef(value: string): EventRefBuilder {
+		this.model.triggerEventRef = value;
+		return this;
+	}
+	
+	
+	withData(value: object): EventRefBuilder {
+		this.model.data = value;
+		return this;
+	}
+	
+	withContextAttributes(value: object): EventRefBuilder {
+		this.model.contextAttributes = value;
+		return this;
+	}
+	
+	build(): EventRefType {
+		
+		if (!this.model.resultEventRef) {
+			throw new Error("Field resultEventRef can not be undefined");
+		}
+		
+		if (!this.model.triggerEventRef) {
+			throw new Error("Field triggerEventRef can not be undefined");
+		}
+		
+		return this.model;
+	}
+}

src/model/types.ts

@@ -62,15 +62,11 @@ export  type EventRefType = {
 	 */
 	data?:
 		| string
-		| {
-		[k: string]: unknown;
-	};
+		| object;
 	/**
 	 * Add additional extension context attributes to the produced event
 	 */
-	contextAttributes?: {
-		[k: string]: string;
-	};
+	contextAttributes?: object;
 };
 
 export type ActionType = {