Merge pull request #108 from neuroglia-io/validation

Validation (+Update & format)

Author: antmendoza

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.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",

src/lib/builders/action-builder.ts

@@ -15,10 +15,9 @@
  *
  */
 
-import { DefinedError } from 'ajv';
 import { Builder, builder } from '../builder';
 import { Specification } from '../definitions';
-import { validators } from '../validators';
+import { validate } from '../utils';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
@@ -27,14 +26,7 @@ import { validators } from '../validators';
  */
 function actionBuildingFn(data: Specification.Action): () => Specification.Action {
   return () => {
-    const validate = validators.get('Action');
-    // TODO: ignore validation if no validator or throw ?
-    if (!validate) return data;
-    if (!validate(data)) {
-      console.warn(validate.errors);
-      const firstError: DefinedError = (validate.errors as DefinedError[])[0];
-      throw new Error(`Action is invalid: ${firstError.message}`);
-    }
+    validate('Action', data);
     return data;
   };
 }

src/lib/builders/actiondatafilter-builder.ts

@@ -15,10 +15,9 @@
  *
  */
 
-import { DefinedError } from 'ajv';
 import { Builder, builder } from '../builder';
 import { Specification } from '../definitions';
-import { validators } from '../validators';
+import { validate } from '../utils';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
@@ -27,14 +26,7 @@ import { validators } from '../validators';
  */
 function actiondatafilterBuildingFn(data: Specification.Actiondatafilter): () => Specification.Actiondatafilter {
   return () => {
-    const validate = validators.get('Actiondatafilter');
-    // TODO: ignore validation if no validator or throw ?
-    if (!validate) return data;
-    if (!validate(data)) {
-      console.warn(validate.errors);
-      const firstError: DefinedError = (validate.errors as DefinedError[])[0];
-      throw new Error(`Actiondatafilter is invalid: ${firstError.message}`);
-    }
+    validate('Actiondatafilter', data);
     return data;
   };
 }

src/lib/builders/branch-builder.ts

@@ -15,10 +15,9 @@
  *
  */
 
-import { DefinedError } from 'ajv';
 import { Builder, builder } from '../builder';
 import { Specification } from '../definitions';
-import { validators } from '../validators';
+import { validate } from '../utils';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
@@ -27,14 +26,7 @@ import { validators } from '../validators';
  */
 function branchBuildingFn(data: Specification.Branch): () => Specification.Branch {
   return () => {
-    const validate = validators.get('Branch');
-    // TODO: ignore validation if no validator or throw ?
-    if (!validate) return data;
-    if (!validate(data)) {
-      console.warn(validate.errors);
-      const firstError: DefinedError = (validate.errors as DefinedError[])[0];
-      throw new Error(`Branch is invalid: ${firstError.message}`);
-    }
+    validate('Branch', data);
     return data;
   };
 }

src/lib/builders/callbackstate-builder.ts

@@ -15,10 +15,9 @@
  *
  */
 
-import { DefinedError } from 'ajv';
 import { Builder, builder } from '../builder';
 import { Specification } from '../definitions';
-import { validators } from '../validators';
+import { validate } from '../utils';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
@@ -28,14 +27,7 @@ import { validators } from '../validators';
 function callbackstateBuildingFn(data: Specification.Callbackstate): () => Specification.Callbackstate {
   return () => {
     data.type = 'callback';
-    const validate = validators.get('Callbackstate');
-    // TODO: ignore validation if no validator or throw ?
-    if (!validate) return data;
-    if (!validate(data)) {
-      console.warn(validate.errors);
-      const firstError: DefinedError = (validate.errors as DefinedError[])[0];
-      throw new Error(`Callbackstate is invalid: ${firstError.message}`);
-    }
+    validate('Callbackstate', data);
     return data;
   };
 }

src/lib/builders/correlation-def-builder.ts

@@ -15,10 +15,9 @@
  *
  */
 
-import { DefinedError } from 'ajv';
 import { Builder, builder } from '../builder';
 import { Specification } from '../definitions';
-import { validators } from '../validators';
+import { validate } from '../utils';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
@@ -27,14 +26,7 @@ import { validators } from '../validators';
  */
 function correlationDefBuildingFn(data: Specification.CorrelationDef): () => Specification.CorrelationDef {
   return () => {
-    const validate = validators.get('CorrelationDef');
-    // TODO: ignore validation if no validator or throw ?
-    if (!validate) return data;
-    if (!validate(data)) {
-      console.warn(validate.errors);
-      const firstError: DefinedError = (validate.errors as DefinedError[])[0];
-      throw new Error(`CorrelationDef is invalid: ${firstError.message}`);
-    }
+    validate('CorrelationDef', data);
     return data;
   };
 }

src/lib/builders/crondef-builder.ts

@@ -15,10 +15,9 @@
  *
  */
 
-import { DefinedError } from 'ajv';
 import { Builder, builder } from '../builder';
 import { Specification } from '../definitions';
-import { validators } from '../validators';
+import { validate } from '../utils';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
@@ -27,14 +26,7 @@ import { validators } from '../validators';
  */
 function crondefBuildingFn(data: Specification.Crondef): () => Specification.Crondef {
   return () => {
-    const validate = validators.get('Crondef');
-    // TODO: ignore validation if no validator or throw ?
-    if (!validate) return data;
-    if (!validate(data)) {
-      console.warn(validate.errors);
-      const firstError: DefinedError = (validate.errors as DefinedError[])[0];
-      throw new Error(`Crondef is invalid: ${firstError.message}`);
-    }
+    validate('Crondef', data);
     return data;
   };
 }

src/lib/builders/databasedswitch-builder.ts

@@ -15,10 +15,9 @@
  *
  */
 
-import { DefinedError } from 'ajv';
 import { Builder, builder } from '../builder';
 import { Specification } from '../definitions';
-import { validators } from '../validators';
+import { validate } from '../utils';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
@@ -28,14 +27,7 @@ import { validators } from '../validators';
 function databasedswitchBuildingFn(data: Specification.Databasedswitch): () => Specification.Databasedswitch {
   return () => {
     data.type = 'switch';
-    const validate = validators.get('Databasedswitch');
-    // TODO: ignore validation if no validator or throw ?
-    if (!validate) return data;
-    if (!validate(data)) {
-      console.warn(validate.errors);
-      const firstError: DefinedError = (validate.errors as DefinedError[])[0];
-      throw new Error(`Databasedswitch is invalid: ${firstError.message}`);
-    }
+    validate('Databasedswitch', data);
     return data;
   };
 }

src/lib/builders/datacondition-builder.ts

@@ -15,10 +15,9 @@
  *
  */
 
-import { DefinedError } from 'ajv';
 import { Builder, builder } from '../builder';
 import { Specification } from '../definitions';
-import { validators } from '../validators';
+import { validate } from '../utils';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
@@ -27,14 +26,7 @@ import { validators } from '../validators';
  */
 function dataconditionBuildingFn(data: Specification.Datacondition): () => Specification.Datacondition {
   return () => {
-    const validate = validators.get('Datacondition');
-    // TODO: ignore validation if no validator or throw ?
-    if (!validate) return data;
-    if (!validate(data)) {
-      console.warn(validate.errors);
-      const firstError: DefinedError = (validate.errors as DefinedError[])[0];
-      throw new Error(`Datacondition is invalid: ${firstError.message}`);
-    }
+    validate('Datacondition', data);
     return data;
   };
 }