Validation (+Update & format)

- updated github url/ref in download schema tool
- added formatting & testing after update-code-base
- updated code base
- added ajv-formats for uri validation, closes #101
- added workflow validation before serializing, closes #102
- added default values in builders, closes #104 #99 #95
- removed object literals from README, closes #106

Signed-off-by: JBBianchi <[email protected]>

Author: JBBianchi

README.md

@@ -73,31 +73,6 @@ const workflow: Specification.Workflow = workflowBuilder()
 ```
 
 
-#### Create Workflow using object literals
-
-```typescript
-import { Specification } from '@severlessworkflow/sdk-typescript';
-
-const workflow: Specification.Workflow = {
-  id: 'helloworld',
-  version: '1.0',
-  name: 'Hello World Workflow',
-  description: 'Inject Hello World',
-  start: 'Hello State',
-  states: [
-    {
-      type: 'inject',
-      name: 'Hello State',
-      end: true,
-      data: {
-        result: "Hello World!"
-      }
-    } as Specification.Injectstate
-  ]
-};
-```
-
-
 #### Load a file JSON/YAML to a Workflow instance
 
 ```typescript

package-lock.json

@@ -18,7 +18,7 @@
     "tools:download-schemas": "npx ts-node --project ./tools/tsconfig.json ./tools/download-schemas.ts",
     "tools:generate-definitions": "npx ts-node --project ./tools/tsconfig.json ./tools/generate-definitions.ts",
     "tools:generate-builders": "npx ts-node --project ./tools/tsconfig.json ./tools/generate-builders.ts",
-    "update-code-base": "npm run tools:download-schemas && npm run tools:generate-definitions && npm run tools:generate-builders",
+    "update-code-base": "npm run tools:download-schemas && npm run tools:generate-definitions && npm run tools:generate-builders && npm run format && npm run test",
     "format": "npx prettier --write \"**/*.ts\"",
     "lint": "npx eslint . --ext .ts && npx prettier --check \"**/*.ts\"",
     "pretest": "npx rimraf out-tsc",
@@ -33,6 +33,7 @@
   },
   "dependencies": {
     "ajv": "^8.1.0",
+    "ajv-formats": "^2.1.0",
     "js-yaml": "^4.1.0"
   },
   "devDependencies": {

package.json

@@ -28,6 +28,7 @@ import { validators } from '../validators';
 function callbackstateBuildingFn(data: Specification.Callbackstate): () => Specification.Callbackstate {
   return () => {
     data.type = 'callback';
+    data.usedForCompensation = data.usedForCompensation || false;
     const validate = validators.get('Callbackstate');
     // TODO: ignore validation if no validator or throw ?
     if (!validate) return data;

src/lib/builders/callbackstate-builder.ts

@@ -28,6 +28,7 @@ import { validators } from '../validators';
 function databasedswitchBuildingFn(data: Specification.Databasedswitch): () => Specification.Databasedswitch {
   return () => {
     data.type = 'switch';
+    data.usedForCompensation = data.usedForCompensation || false;
     const validate = validators.get('Databasedswitch');
     // TODO: ignore validation if no validator or throw ?
     if (!validate) return data;

src/lib/builders/databasedswitch-builder.ts

@@ -28,6 +28,7 @@ import { validators } from '../validators';
 function delaystateBuildingFn(data: Specification.Delaystate): () => Specification.Delaystate {
   return () => {
     data.type = 'delay';
+    data.usedForCompensation = data.usedForCompensation || false;
     const validate = validators.get('Delaystate');
     // TODO: ignore validation if no validator or throw ?
     if (!validate) return data;

src/lib/builders/delaystate-builder.ts

@@ -27,6 +27,10 @@ import { validators } from '../validators';
  */
 function endBuildingFn(data: Specification.End): () => Specification.End {
   return () => {
+    if (typeof data !== typeof true) {
+      (data as any).terminate = (data as any).terminate || false;
+      (data as any).compensate = (data as any).compensate || false;
+    }
     const validate = validators.get('End');
     // TODO: ignore validation if no validator or throw ?
     if (!validate) return data;

src/lib/builders/end-builder.ts

@@ -28,6 +28,7 @@ import { validators } from '../validators';
 function eventbasedswitchBuildingFn(data: Specification.Eventbasedswitch): () => Specification.Eventbasedswitch {
   return () => {
     data.type = 'switch';
+    data.usedForCompensation = data.usedForCompensation || false;
     const validate = validators.get('Eventbasedswitch');
     // TODO: ignore validation if no validator or throw ?
     if (!validate) return data;

src/lib/builders/eventbasedswitch-builder.ts

@@ -28,6 +28,7 @@ import { validators } from '../validators';
 function eventstateBuildingFn(data: Specification.Eventstate): () => Specification.Eventstate {
   return () => {
     data.type = 'event';
+    if (data.exclusive == null) data.exclusive = true;
     const validate = validators.get('Eventstate');
     // TODO: ignore validation if no validator or throw ?
     if (!validate) return data;

src/lib/builders/eventstate-builder.ts

@@ -27,6 +27,7 @@ import { validators } from '../validators';
  */
 function exectimeoutBuildingFn(data: Specification.Exectimeout): () => Specification.Exectimeout {
   return () => {
+    data.interrupt = data.interrupt || false;
     const validate = validators.get('Exectimeout');
     // TODO: ignore validation if no validator or throw ?
     if (!validate) return data;