Skip to content

moved from types to classes #114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ To build the project and run tests locally:
```sh
git clone https://github.com/serverlessworkflow/sdk-typescript.git
cd sdk-typescript
npm install && npm run update-code-base && npm run test
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With or without running the code generation should produce the same output...

npm install && npm run test
```


Expand Down Expand Up @@ -66,7 +66,6 @@ const workflow: Specification.Workflow = workflowBuilder()
.data({
"result": "Hello World!"
})
.end(true)
.build()
])
.build();
Expand All @@ -76,9 +75,9 @@ const workflow: Specification.Workflow = workflowBuilder()
#### Load a file JSON/YAML to a Workflow instance

```typescript
import { Specification, WorkflowConverter } from '@severlessworkflow/sdk-typescript';
import { Specification, Workflow } from '@severlessworkflow/sdk-typescript';

const workflow: Specification.Workflow = WorkflowConverter.fromString(source);
const workflow: Specification.Workflow = Workflow.fromSource(source);
```
Where `source` is a JSON or a YAML string.

Expand Down Expand Up @@ -109,18 +108,18 @@ const workflow: Specification.Workflow = workflowBuilder()
```

You can convert it to its string representation in JSON or YAML format
by using the static methods `toJson` or `toYaml` respectively:
by using the static methods `Workflow.toJson` or `Workflow.toYaml` respectively:

```typescript
import { WorkflowConverter } from '@severlessworkflow/sdk-typescript';
import { Workflow } from '../src/lib/definitions/workflow';

const workflowAsJson: string = WorkflowConverter.toJson(workflow);
const workflowAsJson: string = Workflow.toJson(workflow);
```

```typescript
import { WorkflowConverter } from '@severlessworkflow/sdk-typescript';
import { Workflow } from '../src/lib/definitions/workflow';

const workflowAsYaml: string = WorkflowConverter.toYaml(workflow);
const workflowAsYaml: string = Workflow.toYaml(workflow);
```


Expand Down Expand Up @@ -169,4 +168,4 @@ const injectionStateValidator: ValidateFunction<Specification.Injectstate> = val
if (!injectionStateValidator(injectionState)) {
injectionStateValidator.errors.forEach(error => console.error(error.message));
}
```
```
6 changes: 4 additions & 2 deletions src/lib/builders/action-builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,10 @@ import { validate } from '../utils';
*/
function actionBuildingFn(data: Specification.Action): () => Specification.Action {
return () => {
validate('Action', data);
return data;
const model = new Specification.Action(data);

validate('Action', model);
return model;
};
}

Expand Down
6 changes: 4 additions & 2 deletions src/lib/builders/actiondatafilter-builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,10 @@ import { validate } from '../utils';
*/
function actiondatafilterBuildingFn(data: Specification.Actiondatafilter): () => Specification.Actiondatafilter {
return () => {
validate('Actiondatafilter', data);
return data;
const model = new Specification.Actiondatafilter(data);

validate('Actiondatafilter', model);
return model;
};
}

Expand Down
6 changes: 4 additions & 2 deletions src/lib/builders/branch-builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,10 @@ import { validate } from '../utils';
*/
function branchBuildingFn(data: Specification.Branch): () => Specification.Branch {
return () => {
validate('Branch', data);
return data;
const model = new Specification.Branch(data);

validate('Branch', model);
return model;
};
}

Expand Down
7 changes: 4 additions & 3 deletions src/lib/builders/callbackstate-builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,10 @@ import { validate } from '../utils';
*/
function callbackstateBuildingFn(data: Specification.Callbackstate): () => Specification.Callbackstate {
return () => {
data.type = 'callback';
validate('Callbackstate', data);
return data;
const model = new Specification.Callbackstate(data);

validate('Callbackstate', model);
return model;
};
}

Expand Down
6 changes: 4 additions & 2 deletions src/lib/builders/correlation-def-builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,10 @@ import { validate } from '../utils';
*/
function correlationDefBuildingFn(data: Specification.CorrelationDef): () => Specification.CorrelationDef {
return () => {
validate('CorrelationDef', data);
return data;
const model = new Specification.CorrelationDef(data);

validate('CorrelationDef', model);
return model;
};
}

Expand Down
6 changes: 4 additions & 2 deletions src/lib/builders/crondef-builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,10 @@ import { validate } from '../utils';
*/
function crondefBuildingFn(data: Specification.Crondef): () => Specification.Crondef {
return () => {
validate('Crondef', data);
return data;
const model = new Specification.Crondef(data);

validate('Crondef', model);
return model;
};
}

Expand Down
7 changes: 4 additions & 3 deletions src/lib/builders/databasedswitch-builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,10 @@ import { validate } from '../utils';
*/
function databasedswitchBuildingFn(data: Specification.Databasedswitch): () => Specification.Databasedswitch {
return () => {
data.type = 'switch';
validate('Databasedswitch', data);
return data;
const model = new Specification.Databasedswitch(data);

validate('Databasedswitch', model);
return model;
};
}

Expand Down
40 changes: 0 additions & 40 deletions src/lib/builders/datacondition-builder.ts

This file was deleted.

6 changes: 4 additions & 2 deletions src/lib/builders/defaultdef-builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,10 @@ import { validate } from '../utils';
*/
function defaultdefBuildingFn(data: Specification.Defaultdef): () => Specification.Defaultdef {
return () => {
validate('Defaultdef', data);
return data;
const model = new Specification.Defaultdef(data);

validate('Defaultdef', model);
return model;
};
}

Expand Down
7 changes: 4 additions & 3 deletions src/lib/builders/delaystate-builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,10 @@ import { validate } from '../utils';
*/
function delaystateBuildingFn(data: Specification.Delaystate): () => Specification.Delaystate {
return () => {
data.type = 'delay';
validate('Delaystate', data);
return data;
const model = new Specification.Delaystate(data);

validate('Delaystate', model);
return model;
};
}

Expand Down
6 changes: 4 additions & 2 deletions src/lib/builders/end-builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,10 @@ import { validate } from '../utils';
*/
function endBuildingFn(data: Specification.End): () => Specification.End {
return () => {
validate('End', data);
return data;
const model = new Specification.End(data);

validate('End', model);
return model;
};
}

Expand Down
6 changes: 4 additions & 2 deletions src/lib/builders/enddatacondition-builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,10 @@ import { validate } from '../utils';
*/
function enddataconditionBuildingFn(data: Specification.Enddatacondition): () => Specification.Enddatacondition {
return () => {
validate('Enddatacondition', data);
return data;
const model = new Specification.Enddatacondition(data);

validate('Enddatacondition', model);
return model;
};
}

Expand Down
6 changes: 4 additions & 2 deletions src/lib/builders/enddeventcondition-builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,10 @@ import { validate } from '../utils';
*/
function enddeventconditionBuildingFn(data: Specification.Enddeventcondition): () => Specification.Enddeventcondition {
return () => {
validate('Enddeventcondition', data);
return data;
const model = new Specification.Enddeventcondition(data);

validate('Enddeventcondition', model);
return model;
};
}

Expand Down
6 changes: 4 additions & 2 deletions src/lib/builders/error-builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,10 @@ import { validate } from '../utils';
*/
function errorBuildingFn(data: Specification.Error): () => Specification.Error {
return () => {
validate('Error', data);
return data;
const model = new Specification.Error(data);

validate('Error', model);
return model;
};
}

Expand Down
7 changes: 4 additions & 3 deletions src/lib/builders/eventbasedswitch-builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,10 @@ import { validate } from '../utils';
*/
function eventbasedswitchBuildingFn(data: Specification.Eventbasedswitch): () => Specification.Eventbasedswitch {
return () => {
data.type = 'switch';
validate('Eventbasedswitch', data);
return data;
const model = new Specification.Eventbasedswitch(data);

validate('Eventbasedswitch', model);
return model;
};
}

Expand Down
40 changes: 0 additions & 40 deletions src/lib/builders/eventcondition-builder.ts

This file was deleted.

6 changes: 4 additions & 2 deletions src/lib/builders/eventdatafilter-builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,10 @@ import { validate } from '../utils';
*/
function eventdatafilterBuildingFn(data: Specification.Eventdatafilter): () => Specification.Eventdatafilter {
return () => {
validate('Eventdatafilter', data);
return data;
const model = new Specification.Eventdatafilter(data);

validate('Eventdatafilter', model);
return model;
};
}

Expand Down
7 changes: 4 additions & 3 deletions src/lib/builders/eventdef-builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,10 @@ import { validate } from '../utils';
*/
function eventdefBuildingFn(data: Specification.Eventdef): () => Specification.Eventdef {
return () => {
data.kind = data.kind || 'consumed';
validate('Eventdef', data);
return data;
const model = new Specification.Eventdef(data);

validate('Eventdef', model);
return model;
};
}

Expand Down
6 changes: 4 additions & 2 deletions src/lib/builders/eventref-builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,10 @@ import { validate } from '../utils';
*/
function eventrefBuildingFn(data: Specification.Eventref): () => Specification.Eventref {
return () => {
validate('Eventref', data);
return data;
const model = new Specification.Eventref(data);

validate('Eventref', model);
return model;
};
}

Expand Down
Loading