Merge pull request #49 from antmendoza/support-creation-repeat-object

Support the creation of repeat  object

Author: tsurdilo

spec/repeat-builder.spec.ts

@@ -0,0 +1,46 @@
+/*
+ * 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 {RepeatBuilder} from '../src/model/repeat.builder';
+
+describe('repeat builder', () => {
+	
+	it("Should create empty object", () => {
+		
+		expect(new RepeatBuilder().build()).toEqual({});
+		
+	});
+	
+	it("should create an object with all possible fields", () => {
+		
+		expect(new RepeatBuilder()
+			.withExpression("anyExpression")
+			.withCheckBefore(true)
+			.withMax(3)
+			.withContinueOnError(true)
+			.withStopOnEvents(["onStopEvent"])
+			.build())
+			.toEqual({
+				expression: "anyExpression",
+				checkBefore: true,
+				max: 3,
+				continueOnError: true,
+				stopOnEvents: ["onStopEvent"],
+			});
+		
+	});
+	
+});

src/model/repeat.builder.ts

@@ -0,0 +1,54 @@
+/*
+ * 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 {EventsName, RepeatType} from './types';
+
+export class RepeatBuilder {
+	private model: RepeatType = {};
+	
+	
+	withExpression(value: string): RepeatBuilder {
+		this.model.expression = value;
+		return this;
+	}
+	
+	
+	withCheckBefore(value: boolean): RepeatBuilder {
+		this.model.checkBefore = value;
+		return this;
+	}
+	
+	withMax(value: number): RepeatBuilder {
+		this.model.max = value;
+		return this;
+	}
+	
+	withContinueOnError(value: boolean): RepeatBuilder {
+		this.model.continueOnError = value;
+		return this;
+	}
+	
+	
+	withStopOnEvents(value: EventsName): RepeatBuilder {
+		this.model.stopOnEvents = value;
+		return this;
+	}
+	
+	build(): RepeatType {
+		return this.model;
+	}
+	
+}

src/model/types.ts

@@ -276,7 +276,7 @@ export type EventsDef = | string
 	...EventType[]
 ];
 
-type RetrieType = {
+type RetryType = {
 	/**
 	 * Unique retry strategy name
 	 */
@@ -308,7 +308,34 @@ type RetrieType = {
 };
 export type RetriesDef = | string
 	| [
-	RetrieType,
-	...RetrieType[]
+	RetryType,
+	...RetryType[]
 ];
 
+
+export type EventName = string;
+
+export type EventsName = [EventName, ...EventName[]];
+
+export type RepeatType = {
+	/**
+	 * Expression evaluated against SubFlow state data. SubFlow will repeat execution as long as this expression is true or until the max property count is reached
+	 */
+	expression?: string;
+	/**
+	 * If true, the expression is evaluated before each repeat execution, if false the expression is evaluated after each repeat execution
+	 */
+	checkBefore?: boolean;
+	/**
+	 * Sets the maximum amount of repeat executions
+	 */
+	max?: number;
+	/**
+	 * If true, repeats executions in a case unhandled errors propagate from the sub-workflow to this state
+	 */
+	continueOnError?: boolean;
+	/**
+	 * List referencing defined consumed workflow events. SubFlow will repeat execution until one of the defined events is consumed, or until the max property count is reached
+	 */
+	stopOnEvents?: EventsName;
+};

src/model/workflow.ts

@@ -20,7 +20,7 @@ import {
     DataConditionsType,
     DefaultTransitionType,
     EndType, EventsDef,
-    FunctionsDef, MetadataType, RetriesDef, StartScheduledType,
+    FunctionsDef, MetadataType, RepeatType, RetriesDef, StartScheduledType,
     StateDataFilterType,
     StatesType,
 } from "./types";
@@ -786,6 +786,7 @@ export interface Enddeventcondition {
     metadata?: MetadataType;
 }
 
+
 /**
  * Defines a sub-workflow to be executed
  */
@@ -818,28 +819,7 @@ export interface SubFlowState {
     /**
      * SubFlow state repeat exec definition
      */
-    repeat?: {
-        /**
-         * Expression evaluated against SubFlow state data. SubFlow will repeat execution as long as this expression is true or until the max property count is reached
-         */
-        expression?: string;
-        /**
-         * If true, the expression is evaluated before each repeat execution, if false the expression is evaluated after each repeat execution
-         */
-        checkBefore?: boolean;
-        /**
-         * Sets the maximum amount of repeat executions
-         */
-        max?: number;
-        /**
-         * If true, repeats executions in a case unhandled errors propagate from the sub-workflow to this state
-         */
-        continueOnError?: boolean;
-        /**
-         * List referencing defined consumed workflow events. SubFlow will repeat execution until one of the defined events is consumed, or until the max property count is reached
-         */
-        stopOnEvents?: [string, ...string[]];
-    };
+    repeat?: RepeatType;
     /**
      * State data filter
      */