Merge pull request #56 from antmendoza/support-schedule-object

Support schedule object creation

Author: tsurdilo

spec/schedule-builder.spec.ts

@@ -0,0 +1,74 @@
+/*
+ * 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 {ScheduleBuilder} from '../src/model/schedule.builder';
+import {CronDef} from '../src';
+
+
+describe("ScheduleBuilder", () => {
+	
+	it("should throws an error if mandatory fields are not set ", () => {
+		
+		expect(() => new ScheduleBuilder().build()).toThrowError();
+		
+		expect(() => new ScheduleBuilder()
+			.withInterval("").build())
+			.toThrowError();
+	});
+	
+	
+	it("should create a valid object when interval is set", () => {
+		expect(new ScheduleBuilder()
+			.withInterval("PT2S").build())
+			.toEqual("PT2S");
+	});
+	
+	
+	it("should create a valid object when interval and cron are set", () => {
+		
+		expect(new ScheduleBuilder()
+			.withInterval("PT2S")
+			.withCron(validCronDef())
+			.build())
+			.toEqual({
+				interval: "PT2S",
+				cron: validCronDef(),
+				timezone: "UTC",
+			});
+	});
+	
+	
+	it("should allow set timezone", () => {
+		
+		expect(new ScheduleBuilder()
+			.withInterval("PT2S")
+			.withCron(validCronDef())
+			.withTimezone("CET")
+			.build())
+			.toEqual({
+				interval: "PT2S",
+				cron: validCronDef(),
+				timezone: "CET",
+			});
+	});
+});
+
+
+function validCronDef(): CronDef {
+	return "0 * * ? * *";
+}
+
+

src/index.ts

@@ -14,18 +14,27 @@
  * limitations under the License.
  *
  */
+
 export {BaseWorkflow} from "./base-workflow";
+
 export {ActionBuilder} from "./model/action.builder";
+export {ActionDataFilterBuilder} from "./model/action-data-filter.builder";
+export {CronDefBuilder} from "./model/cron-def.builder";
 export {DatabasedSwitchBuilder} from "./model/databased-switch.builder";
 export {DefaultTransitionTypeBuilder} from "./model/default-transition-type.builder";
-export {FunctionRefImplBuilder} from "./model/function-ref-impl.builder";
+export {EventRefBuilder} from "./model/event-ref.builder";
 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 {RepeatBuilder} from "./model/repeat.builder";
+export {ScheduleBuilder} from "./model/schedule.builder";
 export {SubFlowStateBuilder} from "./model/sub-flow-state.builder";
 export {TransitiondataconditionBuilder} from "./model/transitiondatacondition.builder";
 export {WorkflowBuilder} from "./model/workflow.builder";
+
 export * from "./model/workflow.validator";
+
 export * from "./model/workflow";
 export * from "./model/types";
 

src/model/schedule.builder.ts

@@ -0,0 +1,56 @@
+/*
+ * 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 {CronDef, Interval, Schedule} from '../index';
+
+export class ScheduleBuilder {
+	private interval: Interval;
+	private cron: CronDef;
+	private timezone: string;
+	
+	withInterval(value: Interval): ScheduleBuilder {
+		this.interval = value;
+		return this;
+	}
+	
+	withCron(value: CronDef): ScheduleBuilder {
+		this.cron = value;
+		return this;
+	}
+	
+	withTimezone(value: string): ScheduleBuilder {
+		this.timezone = value;
+		return this;
+	}
+	
+	build(): Schedule {
+		
+		if (!this.interval) {
+			throw new Error("Field interval can not be undefined");
+		}
+		
+		if (this.cron) {
+			return {
+				interval: this.interval,
+				cron: this.cron,
+				timezone: this.timezone || "UTC",
+			};
+		}
+		
+		return this.interval;
+	}
+	
+}

src/model/types.ts

@@ -357,4 +357,5 @@ export type CronDef =
 	 * Specific date and time (ISO 8601 format) when the cron expression invocation is no longer valid
 	 */
 	validUntil?: string;
-};
+};
+export type Interval = string;

src/model/workflow.ts

@@ -20,7 +20,7 @@ import {
     DataConditionsType,
     DefaultTransitionType,
     EndType, EventsDef,
-    FunctionsDef, MetadataType, RepeatType, RetriesDef, StartScheduledType,
+    FunctionsDef, Interval, MetadataType, RepeatType, RetriesDef, StartScheduledType,
     StateDataFilterType,
     StatesType,
 } from "./types";
@@ -82,12 +82,20 @@ export type Startdef =
     | StartScheduledType;
 
 export type Schedule =
-    | string
-    | {
+    |
+    /**
+     * Time interval (must be repeating interval) described with ISO 8601 format. Declares when workflow instances will be automatically created.  (UTC timezone is assumed)
+     */
+    Interval
+    |
+    /**
+     * Start state schedule definition
+     */
+    {
     /**
      * Time interval (must be repeating interval) described with ISO 8601 format. Declares when workflow instances will be automatically created.
      */
-    interval?: string;
+    interval?: Interval;
     cron?: CronDef;
     /**
      * Timezone name used to evaluate the interval & cron-expression. (default: UTC)