0.7.1. (#16)

Author: b4rtaz

CHANGELOG.md

@@ -1,3 +1,17 @@
+## 0.7.1
+
+This version renames all `*ValueModel` functions to `create*ValueModel`, adding the `create` prefix.
+
+```ts
+// Old
+stringValueModel({ ... });
+
+// New
+createStringValueModel({ ... });
+```
+
+This version doesn't introduce breaking changes. The old functions are still available, but they are deprecated.
+
 ## 0.7.0
 
 This version changes the license to the MIT license. 🎉

README.md

@@ -52,12 +52,12 @@ export interface LogStep extends Step {
 Now we can create a model for the step:
 
 ```ts
-import { createStepModel, stringValueModel } from 'sequential-workflow-editor-model';
+import { createStepModel, createStringValueModel } from 'sequential-workflow-editor-model';
 
 export const logStepModel = createStepModel<LogStep>('log', 'task', step => {
   step.property('message')
     .value(
-      stringValueModel({
+      createStringValueModel({
         minLength: 1
       })
     )
@@ -68,12 +68,12 @@ export const logStepModel = createStepModel<LogStep>('log', 'task', step => {
 If your workflow contains global properties you can create a root model:
 
 ```ts
-import { createRootModel, variableDefinitionsValueModel } from 'sequential-workflow-editor-model';
+import { createRootModel, createVariableDefinitionsValueModel } from 'sequential-workflow-editor-model';
 
 export const rootModel = createRootModel<MyDefinition>(root => {
   root.property('inputs')
     .value(
-      variableDefinitionsValueModel({})
+      createVariableDefinitionsValueModel({})
     );
 );
 ```

demos/webpack-app/package.json

@@ -17,9 +17,9 @@
 		"xstate": "^4.37.2",
 		"sequential-workflow-model": "^0.1.4",
 		"sequential-workflow-designer": "^0.13.5",
-		"sequential-workflow-machine": "^0.2.0",
-		"sequential-workflow-editor-model": "^0.7.0",
-		"sequential-workflow-editor": "^0.7.0"
+		"sequential-workflow-machine": "^0.3.0",
+		"sequential-workflow-editor-model": "^0.7.1",
+		"sequential-workflow-editor": "^0.7.1"
 	},
 	"devDependencies": {
 		"ts-loader": "^9.4.2",

demos/webpack-app/src/editors/model/any-variables-step-model.ts

@@ -1,4 +1,4 @@
-import { AnyVariables, anyVariablesValueModel, createStepModel } from 'sequential-workflow-editor-model';
+import { AnyVariables, createAnyVariablesValueModel, createStepModel } from 'sequential-workflow-editor-model';
 import { Step } from 'sequential-workflow-model';
 
 export interface AnyVariablesStepModel extends Step {
@@ -11,9 +11,9 @@ export interface AnyVariablesStepModel extends Step {
 }
 
 export const anyVariablesStepModel = createStepModel<AnyVariablesStepModel>('anyVariables', 'task', step => {
-	step.property('zeroConfig').value(anyVariablesValueModel({}));
+	step.property('zeroConfig').value(createAnyVariablesValueModel({}));
 	step.property('onlyBoolean').value(
-		anyVariablesValueModel({
+		createAnyVariablesValueModel({
 			valueTypes: ['boolean']
 		})
 	);

demos/webpack-app/src/editors/model/boolean-step-model.ts

@@ -1,4 +1,4 @@
-import { booleanValueModel, createStepModel } from 'sequential-workflow-editor-model';
+import { createBooleanValueModel, createStepModel } from 'sequential-workflow-editor-model';
 import { Step } from 'sequential-workflow-model';
 
 export interface BooleanStepModel extends Step {
@@ -12,14 +12,14 @@ export interface BooleanStepModel extends Step {
 }
 
 export const booleanStepModel = createStepModel<BooleanStepModel>('boolean', 'task', step => {
-	step.property('zeroConfig').value(booleanValueModel({}));
+	step.property('zeroConfig').value(createBooleanValueModel({}));
 	step.property('defaultValueTrue').value(
-		booleanValueModel({
+		createBooleanValueModel({
 			defaultValue: true
 		})
 	);
 	step.property('defaultValueFalse').value(
-		booleanValueModel({
+		createBooleanValueModel({
 			defaultValue: false
 		})
 	);

demos/webpack-app/src/editors/model/choice-step-model.ts

@@ -1,4 +1,4 @@
-import { choiceValueModel, createStepModel } from 'sequential-workflow-editor-model';
+import { createChoiceValueModel, createStepModel } from 'sequential-workflow-editor-model';
 import { Step } from 'sequential-workflow-model';
 
 export interface ChoiceStepModel extends Step {
@@ -13,6 +13,6 @@ export interface ChoiceStepModel extends Step {
 export const choiceStepModel = createStepModel<ChoiceStepModel>('choice', 'task', step => {
 	const choices = ['red', 'blue', 'green'];
 
-	step.property('minimalConfig').value(choiceValueModel({ choices }));
-	step.property('defaultValueGreen').value(choiceValueModel({ choices, defaultValue: 'green' }));
+	step.property('minimalConfig').value(createChoiceValueModel({ choices }));
+	step.property('defaultValueGreen').value(createChoiceValueModel({ choices, defaultValue: 'green' }));
 });

demos/webpack-app/src/editors/model/dynamic-step-model.ts

@@ -1,4 +1,10 @@
-import { Dynamic, booleanValueModel, createStepModel, dynamicValueModel, stringValueModel } from 'sequential-workflow-editor-model';
+import {
+	Dynamic,
+	createBooleanValueModel,
+	createStepModel,
+	createDynamicValueModel,
+	createStringValueModel
+} from 'sequential-workflow-editor-model';
 import { Step } from 'sequential-workflow-model';
 
 export interface DynamicStepModel extends Step {
@@ -11,8 +17,8 @@ export interface DynamicStepModel extends Step {
 
 export const dynamicStepModel = createStepModel<DynamicStepModel>('dynamic', 'task', step => {
 	step.property('example').value(
-		dynamicValueModel({
-			models: [stringValueModel({}), booleanValueModel({})]
+		createDynamicValueModel({
+			models: [createStringValueModel({}), createBooleanValueModel({})]
 		})
 	);
 });

demos/webpack-app/src/editors/model/generated-string-step-model.ts

@@ -1,4 +1,4 @@
-import { createStepModel, generatedStringValueModel, numberValueModel } from 'sequential-workflow-editor-model';
+import { createStepModel, createGeneratedStringValueModel, createNumberValueModel } from 'sequential-workflow-editor-model';
 import { Step } from 'sequential-workflow-model';
 
 export interface GeneratedStringStepModel extends Step {
@@ -11,12 +11,12 @@ export interface GeneratedStringStepModel extends Step {
 }
 
 export const generatedStringStepModel = createStepModel<GeneratedStringStepModel>('generatedString', 'task', step => {
-	step.property('x').value(numberValueModel({}));
+	step.property('x').value(createNumberValueModel({}));
 
 	step.property('example')
 		.dependentProperty('x')
 		.value(
-			generatedStringValueModel({
+			createGeneratedStringValueModel({
 				generator(context) {
 					const x = context.getPropertyValue('x');
 					switch (x) {

demos/webpack-app/src/editors/model/nullable-any-variable-step-model.ts

@@ -1,4 +1,4 @@
-import { NullableAnyVariable, createStepModel, nullableAnyVariableValueModel } from 'sequential-workflow-editor-model';
+import { NullableAnyVariable, createStepModel, createNullableAnyVariableValueModel } from 'sequential-workflow-editor-model';
 import { Step } from 'sequential-workflow-model';
 
 export interface NullableAnyVariableStepModel extends Step {
@@ -12,14 +12,14 @@ export interface NullableAnyVariableStepModel extends Step {
 }
 
 export const nullableAnyVariableStepModel = createStepModel<NullableAnyVariableStepModel>('nullableAnyVariable', 'task', step => {
-	step.property('zeroConfig').value(nullableAnyVariableValueModel({}));
+	step.property('zeroConfig').value(createNullableAnyVariableValueModel({}));
 	step.property('required').value(
-		nullableAnyVariableValueModel({
+		createNullableAnyVariableValueModel({
 			isRequired: true
 		})
 	);
 	step.property('onlyNumber').value(
-		nullableAnyVariableValueModel({
+		createNullableAnyVariableValueModel({
 			valueTypes: ['number']
 		})
 	);

demos/webpack-app/src/editors/model/nullable-variable-definition-step-model.ts

@@ -1,4 +1,4 @@
-import { NullableVariableDefinition, createStepModel, nullableVariableDefinitionValueModel } from 'sequential-workflow-editor-model';
+import { NullableVariableDefinition, createStepModel, createNullableVariableDefinitionValueModel } from 'sequential-workflow-editor-model';
 import { Step } from 'sequential-workflow-model';
 
 export interface NullableVariableDefinitionStepModel extends Step {
@@ -16,19 +16,19 @@ export const nullableVariableDefinitionStepModel = createStepModel<NullableVaria
 	'task',
 	step => {
 		step.property('minimalConfig').value(
-			nullableVariableDefinitionValueModel({
+			createNullableVariableDefinitionValueModel({
 				valueType: 'number'
 			})
 		);
 		step.property('required').value(
-			nullableVariableDefinitionValueModel({
+			createNullableVariableDefinitionValueModel({
 				valueType: 'number',
 				isRequired: true
 			})
 		);
 
 		step.property('defaultValue').value(
-			nullableVariableDefinitionValueModel({
+			createNullableVariableDefinitionValueModel({
 				valueType: 'number',
 				defaultValue: {
 					name: 'index',

demos/webpack-app/src/editors/model/nullable-variable-step-model.ts

@@ -1,4 +1,4 @@
-import { NullableVariable, createStepModel, nullableVariableValueModel } from 'sequential-workflow-editor-model';
+import { NullableVariable, createStepModel, createNullableVariableValueModel } from 'sequential-workflow-editor-model';
 import { Step } from 'sequential-workflow-model';
 
 export interface NullableVariableStepModel extends Step {
@@ -12,12 +12,12 @@ export interface NullableVariableStepModel extends Step {
 
 export const nullableVariableStepModel = createStepModel<NullableVariableStepModel>('nullableVariable', 'task', step => {
 	step.property('minimalConfig').value(
-		nullableVariableValueModel({
+		createNullableVariableValueModel({
 			valueType: 'number'
 		})
 	);
 	step.property('required').value(
-		nullableVariableValueModel({
+		createNullableVariableValueModel({
 			valueType: 'number',
 			isRequired: true
 		})

demos/webpack-app/src/editors/model/number-step-model.ts

@@ -1,4 +1,4 @@
-import { createStepModel, numberValueModel } from 'sequential-workflow-editor-model';
+import { createStepModel, createNumberValueModel } from 'sequential-workflow-editor-model';
 import { Step } from 'sequential-workflow-model';
 
 export interface NumberStepModel extends Step {
@@ -13,19 +13,19 @@ export interface NumberStepModel extends Step {
 }
 
 export const numberStepModel = createStepModel<NumberStepModel>('number', 'task', step => {
-	step.property('zeroConfig').value(numberValueModel({}));
+	step.property('zeroConfig').value(createNumberValueModel({}));
 	step.property('defaultValue10').value(
-		numberValueModel({
+		createNumberValueModel({
 			defaultValue: 10
 		})
 	);
 	step.property('min10').value(
-		numberValueModel({
+		createNumberValueModel({
 			min: 10
 		})
 	);
 	step.property('max20').value(
-		numberValueModel({
+		createNumberValueModel({
 			max: 20
 		})
 	);

demos/webpack-app/src/editors/model/root-model.ts

@@ -1,14 +1,14 @@
-import { createRootModel, sequenceValueModel, variableDefinitionsValueModel } from 'sequential-workflow-editor-model';
+import { createRootModel, createSequenceValueModel, createVariableDefinitionsValueModel } from 'sequential-workflow-editor-model';
 import { stepModels } from './step-models';
 
 export const rootModel = createRootModel(root => {
 	root.sequence().value(
-		sequenceValueModel({
+		createSequenceValueModel({
 			sequence: stepModels.map(s => s.type)
 		})
 	);
 	root.property('x').value(
-		variableDefinitionsValueModel({
+		createVariableDefinitionsValueModel({
 			defaultValue: {
 				variables: [
 					{

demos/webpack-app/src/editors/model/string-dictionary-step-model.ts

@@ -1,4 +1,4 @@
-import { StringDictionary, createStepModel, stringDictionaryValueModel } from 'sequential-workflow-editor-model';
+import { StringDictionary, createStepModel, createStringDictionaryValueModel } from 'sequential-workflow-editor-model';
 import { Step } from 'sequential-workflow-model';
 
 export interface StringDictionaryStepModel extends Step {
@@ -12,14 +12,14 @@ export interface StringDictionaryStepModel extends Step {
 }
 
 export const stringDictionaryStepModel = createStepModel<StringDictionaryStepModel>('stringDictionary', 'task', step => {
-	step.property('zeroConfig').value(stringDictionaryValueModel({}));
+	step.property('zeroConfig').value(createStringDictionaryValueModel({}));
 	step.property('uniqueKeys').value(
-		stringDictionaryValueModel({
+		createStringDictionaryValueModel({
 			uniqueKeys: true
 		})
 	);
 	step.property('valueMinLength3').value(
-		stringDictionaryValueModel({
+		createStringDictionaryValueModel({
 			valueMinLength: 3
 		})
 	);

demos/webpack-app/src/editors/model/string-step-model.ts

@@ -1,4 +1,4 @@
-import { createStepModel, stringValueModel } from 'sequential-workflow-editor-model';
+import { createStepModel, createStringValueModel } from 'sequential-workflow-editor-model';
 import { Step } from 'sequential-workflow-model';
 
 export interface StringStepModel extends Step {
@@ -14,24 +14,24 @@ export interface StringStepModel extends Step {
 }
 
 export const stringStepModel = createStepModel<StringStepModel>('string', 'task', step => {
-	step.property('zeroConfig').value(stringValueModel({}));
+	step.property('zeroConfig').value(createStringValueModel({}));
 	step.property('defaultValue').value(
-		stringValueModel({
+		createStringValueModel({
 			defaultValue: 'Some default value'
 		})
 	);
 	step.property('minLength3').value(
-		stringValueModel({
+		createStringValueModel({
 			minLength: 3
 		})
 	);
 	step.property('patternYear').value(
-		stringValueModel({
+		createStringValueModel({
 			pattern: /^\d{4}$/
 		})
 	);
 	step.property('multiLine').value(
-		stringValueModel({
+		createStringValueModel({
 			multiline: true
 		})
 	);

demos/webpack-app/src/editors/model/variable-definitions-step-model.ts

@@ -1,4 +1,4 @@
-import { VariableDefinitions, createStepModel, variableDefinitionsValueModel } from 'sequential-workflow-editor-model';
+import { VariableDefinitions, createStepModel, createVariableDefinitionsValueModel } from 'sequential-workflow-editor-model';
 import { Step } from 'sequential-workflow-model';
 
 export interface VariableDefinitionsStepModel extends Step {
@@ -12,14 +12,14 @@ export interface VariableDefinitionsStepModel extends Step {
 }
 
 export const variableDefinitionsStepModel = createStepModel<VariableDefinitionsStepModel>('variableDefinitions', 'task', step => {
-	step.property('zeroConfig').value(variableDefinitionsValueModel({}));
+	step.property('zeroConfig').value(createVariableDefinitionsValueModel({}));
 	step.property('numberAndBooleanOnly').value(
-		variableDefinitionsValueModel({
+		createVariableDefinitionsValueModel({
 			valueTypes: ['number', 'boolean']
 		})
 	);
 	step.property('defaultValue').value(
-		variableDefinitionsValueModel({
+		createVariableDefinitionsValueModel({
 			defaultValue: {
 				variables: [
 					{ name: 'x', type: 'number' },

demos/webpack-app/src/playground/machine/activities/calculate-activity.ts

@@ -2,9 +2,8 @@ import { createAtomActivity } from 'sequential-workflow-machine';
 import { GlobalState } from '../global-state';
 import { CalculateStep } from '../../model/calculate-step-model';
 
-export const calculateActivity = createAtomActivity<CalculateStep, GlobalState>({
+export const calculateActivity = createAtomActivity<CalculateStep, GlobalState>('calculate', {
 	init: () => ({}),
-	stepType: 'calculate',
 	handler: async (step: CalculateStep, { $variables, $dynamics }: GlobalState) => {
 		if (!step.properties.result) {
 			throw new Error('Result variable is not defined');

demos/webpack-app/src/playground/machine/activities/convert-value-activity.ts

@@ -2,9 +2,8 @@ import { createAtomActivity } from 'sequential-workflow-machine';
 import { GlobalState } from '../global-state';
 import { ConvertValueStep } from '../../model/convert-value-step-model';
 
-export const convertValueActivity = createAtomActivity<ConvertValueStep, GlobalState>({
+export const convertValueActivity = createAtomActivity<ConvertValueStep, GlobalState>('convertValue', {
 	init: () => ({}),
-	stepType: 'convertValue',
 	handler: async (step: ConvertValueStep, { $variables }: GlobalState) => {
 		if (!step.properties.source) {
 			throw new Error('Source variable is required');

demos/webpack-app/src/playground/machine/activities/if-activity.ts

@@ -3,8 +3,7 @@ import { branchName, createForkActivity } from 'sequential-workflow-machine';
 import { IfStep } from '../../model/if-step-model';
 import { GlobalState } from '../global-state';
 
-export const ifActivity = createForkActivity<IfStep, GlobalState>({
-	stepType: 'if',
+export const ifActivity = createForkActivity<IfStep, GlobalState>('if', {
 	init: () => ({}),
 	handler: async (step: IfStep, { $dynamics }: GlobalState) => {
 		const a = $dynamics.readAny<any>(step.properties.a);