@output.ai/core 0.1.11 → 0.1.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@output.ai/core",
-  "version": "0.1.11",
+  "version": "0.1.13",
   "description": "The core module of the output framework",
   "type": "module",
   "exports": {

package/src/index.d.ts

@@ -21,18 +21,28 @@ export { z } from 'zod';
 type AnyZodSchema = z.ZodType<any, any, any>;
 
 /**
- * Activity retry options accepted by step/evaluator/workflow definitions.
- * Uses Temporal's ActivityOptions['retry'] type.
+ * Activity options accepted by step/evaluator/workflow definitions.
+ * Exposes supported Temporal ActivityOptions.
+ *
+ * @description Exposes supported Temporal ActivityOptions
  */
-export type Options = { retry?: ActivityOptions['retry'] };
+export type Options = Omit<ActivityOptions, 'versioningIntent' | 'taskQueue' | 'allowEagerDispatch'>;
 
 /**
- * @typedef {object} Options
- * @property {import('@temporalio/workflow').ActivityOptions['retry']} [retry]
+ * The last argument when calling workflows is used to configure it
  */
-
 export type WorkflowCallConfig = {
-  options?: ActivityOptions
+
+  /**
+   * Temporal Activity Options
+   */
+  options?: Options,
+
+  /**
+   * Whether this workflow will run detached or not.
+   * Detached workflows called without explicitly awaiting for the result will be "fire-an-forget", outliving the parent.
+   */
+  detached?: boolean
 };
 
 /*

package/src/interface/validations/static.js

@@ -17,10 +17,16 @@ const refineSchema = ( value, ctx ) => {
   } );
 };
 
-export const durationStringSchema = z.string().regex(
+export const durationSchema = z.union( [ z.string().regex(
   /^(\d+)(ms|s|m|h|d)$/,
   'Expected duration like "500ms", "10s", "5m", "2h", or "1d"'
-);
+), z.number() ] );
+
+export const prioritySchema = z.object( {
+  fairnessKey: z.string().optional(),
+  fairnessWeight: z.number().min( 0.0001 ).max( 1000 ).optional(),
+  priorityKey: z.number().min( 1 ).optional()
+} );
 
 const stepAndWorkflowSchema = z.strictObject( {
   name: z.string().regex( /^[a-z_][a-z0-9_]*$/i ),
@@ -29,13 +35,21 @@ const stepAndWorkflowSchema = z.strictObject( {
   outputSchema: z.any().optional().superRefine( refineSchema ),
   fn: z.function(),
   options: z.strictObject( {
+    activityId: z.string().optional(),
+    cancellationType: z.enum( [ 'TRY_CANCEL', 'WAIT_CANCELLATION_COMPLETED', 'ABANDON' ] ).optional(),
+    heartbeatTimeout: durationSchema.optional(),
+    priority: prioritySchema.optional(),
     retry: z.strictObject( {
-      initialInterval: durationStringSchema.optional(),
+      initialInterval: durationSchema.optional(),
       backoffCoefficient: z.number().gte( 1 ).optional(),
-      maximumInterval: durationStringSchema.optional(),
+      maximumInterval: durationSchema.optional(),
       maximumAttempts: z.number().gte( 1 ).int().optional(),
       nonRetryableErrorTypes: z.array( z.string() ).optional()
-    } ).optional()
+    } ).optional(),
+    scheduleToCloseTimeout: durationSchema.optional(),
+    scheduleToStartTimeout: durationSchema.optional(),
+    startToCloseTimeout: durationSchema.optional(),
+    summary: z.string().optional()
   } ).optional()
 } );
 

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

@@ -82,6 +82,71 @@ describe( 'interface/validator', () => {
       expect( () => validateStep( args ) ).not.toThrow();
     } );
 
+    it( 'passes with options.activityId as string', () => {
+      expect( () => validateStep( { ...validArgs, options: { activityId: 'act-123' } } ) ).not.toThrow();
+    } );
+
+    it( 'rejects non-string options.activityId', () => {
+      expect( () => validateStep( { ...validArgs, options: { activityId: 123 } } ) ).toThrow( StaticValidationError );
+    } );
+
+    it( 'passes with valid options.cancellationType values', () => {
+      for ( const v of [ 'TRY_CANCEL', 'WAIT_CANCELLATION_COMPLETED', 'ABANDON' ] ) {
+        expect( () => validateStep( { ...validArgs, options: { cancellationType: v } } ) ).not.toThrow();
+      }
+    } );
+
+    it( 'rejects invalid options.cancellationType', () => {
+      expect( () => validateStep( { ...validArgs, options: { cancellationType: 'INVALID' } } ) ).toThrow( StaticValidationError );
+    } );
+
+    it( 'accepts duration fields in options', () => {
+      const options = {
+        heartbeatTimeout: '1s',
+        scheduleToCloseTimeout: '2m',
+        scheduleToStartTimeout: '3m',
+        startToCloseTimeout: '4m'
+      };
+      expect( () => validateStep( { ...validArgs, options } ) ).not.toThrow();
+    } );
+
+    it( 'rejects invalid duration string in heartbeatTimeout', () => {
+      expect( () => validateStep( { ...validArgs, options: { heartbeatTimeout: '5x' } } ) ).toThrow( StaticValidationError );
+    } );
+
+    it( 'passes with options.summary string', () => {
+      expect( () => validateStep( { ...validArgs, options: { summary: 'brief' } } ) ).not.toThrow();
+    } );
+
+    it( 'rejects non-string options.summary', () => {
+      expect( () => validateStep( { ...validArgs, options: { summary: 42 } } ) ).toThrow( StaticValidationError );
+    } );
+
+    it( 'passes with options.priority valid payload', () => {
+      const options = {
+        priority: {
+          fairnessKey: 'user-1',
+          fairnessWeight: 1.5,
+          priorityKey: 10
+        }
+      };
+      expect( () => validateStep( { ...validArgs, options } ) ).not.toThrow();
+    } );
+
+    it( 'rejects invalid options.priority values', () => {
+      const options = { priority: { fairnessWeight: 0, priorityKey: 0 } };
+      expect( () => validateStep( { ...validArgs, options } ) ).toThrow( StaticValidationError );
+    } );
+
+    it( 'rejects invalid options.retry values', () => {
+      const options = { retry: { backoffCoefficient: 0.5, maximumAttempts: 0, nonRetryableErrorTypes: [ 1 ] } };
+      expect( () => validateStep( { ...validArgs, options } ) ).toThrow( StaticValidationError );
+    } );
+
+    it( 'rejects unknown keys inside options due to strictObject', () => {
+      expect( () => validateStep( { ...validArgs, options: { unknownKey: true } } ) ).toThrow( StaticValidationError );
+    } );
+
     it( 'rejects unknown top-level keys due to strictObject', () => {
       expect( () => validateStep( { ...validArgs, extra: 123 } ) ).toThrow( StaticValidationError );
     } );

package/src/interface/workflow.js

@@ -1,5 +1,5 @@
 // THIS RUNS IN THE TEMPORAL'S SANDBOX ENVIRONMENT
-import { proxyActivities, inWorkflowContext, executeChild, workflowInfo } from '@temporalio/workflow';
+import { proxyActivities, inWorkflowContext, executeChild, workflowInfo, ParentClosePolicy } from '@temporalio/workflow';
 import { validateWorkflow } from './validations/static.js';
 import { validateWithSchema } from './validations/runtime.js';
 import { SHARED_STEP_PREFIX, ACTIVITY_GET_TRACE_DESTINATIONS } from '#consts';
@@ -59,18 +59,28 @@ export function workflow( { name, description, inputSchema, outputSchema, fn, op
       invokeSharedStep: async ( stepName, input, options ) => steps[`${SHARED_STEP_PREFIX}#${stepName}`]( input, options ),
       invokeEvaluator: async ( evaluatorName, input, options ) => steps[`${workflowPath}#${evaluatorName}`]( input, options ),
 
-      startWorkflow: async ( childName, input, extra = {} ) => {
-        return executeChild( childName, {
+      /**
+       * Start a child workflow
+       *
+       * @param {string} childName
+       * @param {unknown} input
+       * @param {object} extra
+       * @param {boolean} extra.detached
+       * @param {import('@temporalio/workflow').ActivityOptions} extra.options
+       * @returns
+       */
+      startWorkflow: async ( childName, input, extra = {} ) =>
+        executeChild( childName, {
           args: input ? [ input ] : [],
           workflowId: `${workflowId}-${childName}-${Date.now()}`,
+          parentClosePolicy: ParentClosePolicy[extra?.detached ? 'ABANDON' : 'TERMINATE'],
           memo: {
             executionContext,
             parentId: workflowId,
             // new configuration for activities of the child workflow, this will be omitted so it will use what that workflow have defined
             ...( extra?.options && { activityOptions: mergeActivityOptions( activityOptions, extra.options ) } )
           }
-        } );
-      }
+        } )
     }, input );
 
     validateWithSchema( outputSchema, output, `Workflow ${name} output` );