@output.ai/core 0.0.13 → 0.0.15

package/src/worker/catalog_workflow/index.js

@@ -1,6 +1,26 @@
+import { z } from 'zod';
 import { METADATA_ACCESS_SYMBOL } from '#consts';
 import { Catalog, CatalogActivity, CatalogWorkflow } from './catalog.js';
 
+/**
+ * Converts a Zod schema to JSON Schema format.
+ *
+ * @param {any} schema - A zod schema
+ * @returns {object|null} JSON Schema object, or null if schema is invalid
+ */
+const convertToJsonSchema = schema => {
+  if ( !schema ) {
+    return null;
+  }
+
+  try {
+    return z.toJSONSchema( schema );
+  } catch ( error ) {
+    console.warn( 'Invalid schema provided (expected Zod schema):', schema, error );
+    return null;
+  }
+};
+
 /**
  * Converts the list of workflows and the activities into the catalog information.
  *
@@ -14,8 +34,17 @@ export const createCatalog = ( { workflows, activities } ) =>
   workflows.reduce( ( catalog, workflow ) =>
     catalog.addWorkflow( new CatalogWorkflow( {
       ...workflow,
+      inputSchema: convertToJsonSchema( workflow.inputSchema ),
+      outputSchema: convertToJsonSchema( workflow.outputSchema ),
       activities: Object.entries( activities )
         .filter( ( [ k ] ) => k.startsWith( `${workflow.path}#` ) )
-        .map( ( [ _, v ] ) => new CatalogActivity( v[METADATA_ACCESS_SYMBOL] ) )
+        .map( ( [ _, v ] ) => {
+          const metadata = v[METADATA_ACCESS_SYMBOL];
+          return new CatalogActivity( {
+            ...metadata,
+            inputSchema: convertToJsonSchema( metadata.inputSchema ),
+            outputSchema: convertToJsonSchema( metadata.outputSchema )
+          } );
+        } )
     } ) )
   , new Catalog() );

package/src/worker/catalog_workflow/index.spec.js

@@ -1,4 +1,5 @@
 import { describe, it, expect, vi } from 'vitest';
+import { z } from 'zod';
 
 // Provide the same symbol to the module under test and to the test
 const METADATA_ACCESS_SYMBOL = Symbol( '__metadata' );
@@ -19,16 +20,16 @@ describe( 'createCatalog', () => {
         path: '/flows/flow1',
         pathname: '/flows/flow1/workflow.js',
         description: 'desc-flow1',
-        inputSchema: { in: 'f1' },
-        outputSchema: { out: 'f1' }
+        inputSchema: z.object( { in: z.literal( 'f1' ) } ),
+        outputSchema: z.object( { out: z.literal( 'f1' ) } )
       },
       {
         name: 'flow2',
         path: '/flows/flow2',
         pathname: '/flows/flow2/workflow.js',
         description: 'desc-flow2',
-        inputSchema: { in: 'f2' },
-        outputSchema: { out: 'f2' }
+        inputSchema: z.object( { in: z.literal( 'f2' ) } ),
+        outputSchema: z.object( { out: z.literal( 'f2' ) } )
       }
     ];
 
@@ -37,8 +38,8 @@ describe( 'createCatalog', () => {
       name: 'A1',
       path: '/flows/flow1#A1',
       description: 'desc-a1',
-      inputSchema: { in: 'a1' },
-      outputSchema: { out: 'a1' }
+      inputSchema: z.object( { in: z.literal( 'a1' ) } ),
+      outputSchema: z.object( { out: z.literal( 'a1' ) } )
     } );
 
     const activity2 = () => {};
@@ -46,8 +47,8 @@ describe( 'createCatalog', () => {
       name: 'A2',
       path: '/flows/flow1#A2',
       description: 'desc-a2',
-      inputSchema: { in: 'a2' },
-      outputSchema: { out: 'a2' }
+      inputSchema: z.object( { in: z.literal( 'a2' ) } ),
+      outputSchema: z.object( { out: z.literal( 'a2' ) } )
     } );
 
     const activity3 = () => {};
@@ -55,8 +56,8 @@ describe( 'createCatalog', () => {
       name: 'B1',
       path: '/flows/flow2#B1',
       description: 'desc-b1',
-      inputSchema: { in: 'b1' },
-      outputSchema: { out: 'b1' }
+      inputSchema: z.object( { in: z.literal( 'b1' ) } ),
+      outputSchema: z.object( { out: z.literal( 'b1' ) } )
     } );
 
     const activity4 = () => {};
@@ -64,8 +65,8 @@ describe( 'createCatalog', () => {
       name: 'X',
       path: '/other#X',
       description: 'desc-x',
-      inputSchema: { in: 'x' },
-      outputSchema: { out: 'x' }
+      inputSchema: z.object( { in: z.literal( 'x' ) } ),
+      outputSchema: z.object( { out: z.literal( 'x' ) } )
     } );
 
     const activities = {
@@ -96,20 +97,56 @@ describe( 'createCatalog', () => {
         name: 'flow1',
         path: '/flows/flow1',
         description: 'desc-flow1',
-        inputSchema: { in: 'f1' },
-        outputSchema: { out: 'f1' },
+        inputSchema: {
+          $schema: 'https://json-schema.org/draft/2020-12/schema',
+          type: 'object',
+          properties: { in: { type: 'string', const: 'f1' } },
+          required: [ 'in' ],
+          additionalProperties: false
+        },
+        outputSchema: {
+          $schema: 'https://json-schema.org/draft/2020-12/schema',
+          type: 'object',
+          properties: { out: { type: 'string', const: 'f1' } },
+          required: [ 'out' ],
+          additionalProperties: false
+        },
         activities: [
           {
             name: 'A1',
             description: 'desc-a1',
-            inputSchema: { in: 'a1' },
-            outputSchema: { out: 'a1' }
+            inputSchema: {
+              $schema: 'https://json-schema.org/draft/2020-12/schema',
+              type: 'object',
+              properties: { in: { type: 'string', const: 'a1' } },
+              required: [ 'in' ],
+              additionalProperties: false
+            },
+            outputSchema: {
+              $schema: 'https://json-schema.org/draft/2020-12/schema',
+              type: 'object',
+              properties: { out: { type: 'string', const: 'a1' } },
+              required: [ 'out' ],
+              additionalProperties: false
+            }
           },
           {
             name: 'A2',
             description: 'desc-a2',
-            inputSchema: { in: 'a2' },
-            outputSchema: { out: 'a2' }
+            inputSchema: {
+              $schema: 'https://json-schema.org/draft/2020-12/schema',
+              type: 'object',
+              properties: { in: { type: 'string', const: 'a2' } },
+              required: [ 'in' ],
+              additionalProperties: false
+            },
+            outputSchema: {
+              $schema: 'https://json-schema.org/draft/2020-12/schema',
+              type: 'object',
+              properties: { out: { type: 'string', const: 'a2' } },
+              required: [ 'out' ],
+              additionalProperties: false
+            }
           }
         ]
       },
@@ -117,14 +154,38 @@ describe( 'createCatalog', () => {
         name: 'flow2',
         path: '/flows/flow2',
         description: 'desc-flow2',
-        inputSchema: { in: 'f2' },
-        outputSchema: { out: 'f2' },
+        inputSchema: {
+          $schema: 'https://json-schema.org/draft/2020-12/schema',
+          type: 'object',
+          properties: { in: { type: 'string', const: 'f2' } },
+          required: [ 'in' ],
+          additionalProperties: false
+        },
+        outputSchema: {
+          $schema: 'https://json-schema.org/draft/2020-12/schema',
+          type: 'object',
+          properties: { out: { type: 'string', const: 'f2' } },
+          required: [ 'out' ],
+          additionalProperties: false
+        },
         activities: [
           {
             name: 'B1',
             description: 'desc-b1',
-            inputSchema: { in: 'b1' },
-            outputSchema: { out: 'b1' }
+            inputSchema: {
+              $schema: 'https://json-schema.org/draft/2020-12/schema',
+              type: 'object',
+              properties: { in: { type: 'string', const: 'b1' } },
+              required: [ 'in' ],
+              additionalProperties: false
+            },
+            outputSchema: {
+              $schema: 'https://json-schema.org/draft/2020-12/schema',
+              type: 'object',
+              properties: { out: { type: 'string', const: 'b1' } },
+              required: [ 'out' ],
+              additionalProperties: false
+            }
           }
         ]
       }

package/src/interface/validations/ajv_provider.js

@@ -1,3 +0,0 @@
-import Ajv from 'ajv';
-
-export const ajv = new Ajv();

package/src/interface/validations/runtime.js

@@ -1,69 +0,0 @@
-import { FatalError } from '#errors';
-import { ajv } from './ajv_provider.js';
-
-/**
- * Error type for when the input/output of a step/workflow doesn't match its input/output schema, respectively
- */
-export class MismatchSchemaError extends FatalError {}
-/**
- * Error type for when the input of a step/workflow doesn't match its input schema
- * @extends MismatchSchemaError
- */
-export class InvalidInputError extends MismatchSchemaError {}
-/**
- * Error type for when the output of a step/workflow doesn't match its output schema
- * @extends MismatchSchemaError
- */
-export class InvalidOutputError extends MismatchSchemaError {}
-
-const validate = ( ErrorClass, type, name, schema, payload ) => {
-  const validate = ajv.compile( schema );
-  const valid = validate( payload );
-
-  if ( !valid ) {
-    throw new ErrorClass( `Invalid input at ${type} "${name}": ${ajv.errorsText( validate.errors )}` );
-  }
-};
-
-const validateInput = validate.bind( null, InvalidInputError );
-const validateOutput = validate.bind( null, InvalidOutputError );
-
-/**
- * Validates step input
- *
- * @param {name} name - step's name
- * @param {object} schema - step's input schema
- * @param {any} - the input to validate
- * @throws InvalidInputError
- */
-export const validateStepInput = validateInput.bind( null, 'step' );
-
-/**
- * Validates step output
- *
- * @param {name} name - step's name
- * @param {object} schema - step's output schema
- * @param {any} - the output to validate
- * @throws InvalidOutputError
- */
-export const validateStepOutput = validateOutput.bind( null, 'step' );
-
-/**
- * Validates workflow input
- *
- * @param {name} name - workflow's name
- * @param {object} schema - workflow's input schema
- * @param {any} - the input to validate
- * @throws InvalidInputError
- */
-export const validateWorkflowInput = validateInput.bind( null, 'workflow' );
-
-/**
- * Validates workflow output
- *
- * @param {name} name - workflow's name
- * @param {object} schema - workflow's output schema
- * @param {any} - the output to validate
- * @throws InvalidOutputError
- */
-export const validateWorkflowOutput = validateOutput.bind( null, 'workflow' );

package/src/interface/validations/runtime.spec.js

@@ -1,50 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import { validateStepInput, validateWorkflowInput, InvalidInputError } from './runtime.js';
-
-describe( 'Runtime validations spec', () => {
-  describe( 'validateStepInput', () => {
-    it( 'passes with matching payload', () => {
-      const schema = {
-        type: 'object',
-        properties: { id: { type: 'string' }, count: { type: 'integer', minimum: 0 } },
-        required: [ 'id' ],
-        additionalProperties: false
-      };
-      expect( () => validateStepInput( 'myStep', schema, { id: 'x', count: 2 } ) ).not.toThrow();
-    } );
-
-    it( 'rejects invalid payload', () => {
-      const schema = {
-        type: 'object',
-        properties: { id: { type: 'string' }, count: { type: 'integer', minimum: 0 } },
-        required: [ 'id' ],
-        additionalProperties: false
-      };
-      const error = new InvalidInputError( 'Invalid input at step "myStep": data must have required property \'id\'' );
-      expect( () => validateStepInput( 'myStep', schema, { count: -1 } ) ).toThrow( error );
-    } );
-  } );
-
-  describe( 'validateWorkflowInput', () => {
-    it( 'passes with matching payload', () => {
-      const schema = {
-        type: 'object',
-        properties: { name: { type: 'string' }, enabled: { type: 'boolean' } },
-        required: [ 'name' ],
-        additionalProperties: false
-      };
-      expect( () => validateWorkflowInput( 'myWorkflow', schema, { name: 'wf', enabled: true } ) ).not.toThrow();
-    } );
-
-    it( 'rejects invalid payload', () => {
-      const schema = {
-        type: 'object',
-        properties: { name: { type: 'string' }, enabled: { type: 'boolean' } },
-        required: [ 'name' ],
-        additionalProperties: false
-      };
-      const error = new InvalidInputError( 'Invalid input at workflow "myWorkflow": data must have required property \'name\'' );
-      expect( () => validateWorkflowInput( 'myWorkflow', schema, { enabled: 'yes' } ) ).toThrow( error );
-    } );
-  } );
-} );