added metadata.builder

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

Author: antmendoza

spec/metadata-builder.spec.ts

@@ -0,0 +1,68 @@
+/*
+ * 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 {MetadataBuilder} from '../src/model/metadata.builder';
+
+
+describe("MetadataBuilder", () => {
+	
+	it("should create an empty object ", () => {
+		
+		expect(new MetadataBuilder().build()).toEqual({});
+		
+	});
+	
+	it("should create an object with key/value strings ", () => {
+		
+		expect(new MetadataBuilder()
+			.withKeyValue("k1", "v1")
+			.build()).toEqual(
+			{
+				"k1": "v1",
+			});
+		
+		
+		expect(new MetadataBuilder()
+			.withKeyValue("k2", "v2")
+			.withKeyValue("k3", "v3")
+			.build()).toEqual(
+			{
+				"k2": "v2",
+				"k3": "v3",
+			});
+		
+		
+	});
+	
+	
+	it("should allow to overwrite pairs of key/value  ", () => {
+		
+		expect(new MetadataBuilder()
+			.withKeyValue("k1", "v1")
+			.withKeyValue("k1", "v2")
+			.build()).toEqual(
+			{
+				"k1": "v2",
+			});
+		
+		
+	});
+	
+	
+});
+
+
+

src/index.ts

@@ -26,6 +26,7 @@ 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 {MetadataBuilder} from "./model/metadata.builder";
 export {OperationStateBuilder} from "./model/operation-state.builder";
 export {ProduceEventDefBuilder} from "./model/produce-event-def.builder";
 export {RepeatBuilder} from "./model/repeat.builder";

src/model/metadata.builder.ts

@@ -0,0 +1,34 @@
+/*
+ * 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 {Metadata} from '../index';
+
+export class MetadataBuilder {
+	
+	private model: Metadata = {};
+	
+	withKeyValue(key: string, value: string): MetadataBuilder {
+		
+		Object.assign(this.model, {[key]: value});
+		return this;
+		
+	}
+	
+	build(): Metadata {
+		return this.model;
+	}
+	
+}

src/model/types.ts

@@ -199,7 +199,7 @@ export type StartScheduledType = {
 	schedule: Schedule;
 };
 
-export type MetadataType = {
+export type Metadata = {
 	[k: string]: string;
 };
 
@@ -248,7 +248,7 @@ type EventType = {
 	/**
 	 * Metadata information
 	 */
-	metadata?: MetadataType;
+	metadata?: Metadata;
 };
 export type EventsDef = | string
 	| [

src/model/workflow.builder.ts

@@ -15,7 +15,7 @@
  *
  */
 import {Exectimeout, StartDef, Workflow} from "./workflow";
-import {EventsDef, FunctionsDef, MetadataType, RetriesDef, StatesType} from "./types";
+import {EventsDef, FunctionsDef, Metadata, RetriesDef, StatesType} from "./types";
 import {ValidatorFactory} from "./workflow.validator";
 
 
@@ -87,7 +87,7 @@ export class WorkflowBuilder {
 		return this;
 	}
 
-	withMetadata(value: MetadataType): WorkflowBuilder {
+	withMetadata(value: Metadata): WorkflowBuilder {
 		this.model.metadata = value;
 		return this;
 	}

src/model/workflow.ts

@@ -20,7 +20,7 @@ import {
     DataConditionsType,
     DefaultTransitionType,
     EndType, EventsDef,
-    FunctionsDef, Interval, MetadataType, ProduceEventsDef, RepeatType, RetriesDef, StartScheduledType,
+    FunctionsDef, Interval, Metadata, ProduceEventsDef, RepeatType, RetriesDef, StartScheduledType,
     StateDataFilterType,
     StatesType,
 } from "./types";
@@ -63,7 +63,7 @@ export type Workflow = {
     /**
      * Metadata information
      */
-    metadata?: MetadataType;
+    metadata?: Metadata;
     events?: EventsDef;
     functions?:FunctionsDef;
     retries?:RetriesDef;
@@ -235,7 +235,7 @@ export interface DelayState {
     /**
      * Metadata information
      */
-    metadata?: MetadataType;
+    metadata?: Metadata;
 }
 
 
@@ -313,7 +313,7 @@ export interface OperationState {
     /**
      * Metadata information
      */
-    metadata?: MetadataType;
+    metadata?: Metadata;
 }
 
 /**
@@ -401,7 +401,7 @@ export interface ParallelState {
     /**
      * Metadata information
      */
-    metadata?: MetadataType;
+    metadata?: Metadata;
 }
 
 
@@ -455,7 +455,7 @@ export interface Databasedswitch {
     /**
      * Metadata information
      */
-    metadata?: MetadataType;
+    metadata?: Metadata;
 }
 
 /**
@@ -492,7 +492,7 @@ export interface Transitiondatacondition {
     /**
      * Metadata information
      */
-    metadata?: MetadataType;
+    metadata?: Metadata;
 }
 
 /**
@@ -514,7 +514,7 @@ export interface Enddatacondition {
     /**
      * Metadata information
      */
-    metadata?: MetadataType;
+    metadata?: Metadata;
 }
 
 /**
@@ -571,7 +571,7 @@ export interface Eventbasedswitch {
     /**
      * Metadata information
      */
-    metadata?: MetadataType;
+    metadata?: Metadata;
 }
 
 /**
@@ -621,7 +621,7 @@ export interface Transitioneventcondition {
     /**
      * Metadata information
      */
-    metadata?: MetadataType;
+    metadata?: Metadata;
 }
 
 /**
@@ -657,7 +657,7 @@ export interface Enddeventcondition {
     /**
      * Metadata information
      */
-    metadata?: MetadataType;
+    metadata?: Metadata;
 }
 
 
@@ -739,7 +739,7 @@ export interface SubFlowState {
     /**
      * Metadata information
      */
-    metadata?: MetadataType;
+    metadata?: Metadata;
 }
 
 /**
@@ -803,7 +803,7 @@ export interface InjectState {
     /**
      * Metadata information
      */
-    metadata?: MetadataType;
+    metadata?: Metadata;
 }
 
 /**
@@ -903,7 +903,7 @@ export interface ForEachState {
     /**
      * Metadata information
      */
-    metadata?: MetadataType;
+    metadata?: Metadata;
 }
 
 /**
@@ -1003,7 +1003,7 @@ export interface CallbackState {
     /**
      * Metadata information
      */
-    metadata?: MetadataType;
+    metadata?: Metadata;
 }