@codesoul-co/hypha-core / modules/execution-activities/index

• Package index: @codesoul-co/hypha-core
• Source: packages/core/src/modules/execution-activities/index.ts
• Exports: 14

Using this module

Use the Index module for executing runtime behavior at this boundary. It exports 11 constants, 3 functions.

Import from the package entrypoint

import {
  executionActivityJsonSchemas,
  executionActivityRequestExample,
  executionActivityRequestJsonSchema,
  executionActivityRequestSchema,
  executionActivityResultExample,
  executionActivityResultJsonSchema,
  executionActivityResultSchema,
  executionActivityStatusSchema,
} from '@codesoul-co/hypha-core';

// The complete export list is documented below.

Usage patterns

• The module exposes 3 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.
• The 11 constant/enum exports provide stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.

Runtime validation example

import { executionActivityRequestSchema } from '@codesoul-co/hypha-core';

declare function loadExternalInput(): unknown;
const input: unknown = loadExternalInput();
const parsed = executionActivityRequestSchema.parse(input);

Parse untrusted configuration, network, or persisted input with the runtime schema before passing it to functions or classes that expect a validated contract.

Public exports

Symbol	Kind	Signature	Description
executionActivityJsonSchemas	constant	const executionActivityJsonSchemas: Record<string, JsonSchema>	Execution Activity JSON Schemas constant exported by the modules/execution-activities/index module.
executionActivityRequestExample	constant	const executionActivityRequestExample: ExecutionActivityRequest	Valid example value for Execution Activity Request.
executionActivityRequestJsonSchema	constant	const executionActivityRequestJsonSchema: JsonSchema	JSON Schema for Execution Activity Request.
executionActivityRequestSchema	constant	const executionActivityRequestSchema: z.ZodEffects<z.ZodObject<{ activityId: z.ZodString; operationId: z.ZodString; runId: z.ZodString; stateAttemptId: z.ZodString; workspaceId: z.ZodString; request: z.ZodUnion<[z.ZodEffects<z.ZodObject<{ executionId: z.ZodOptional<z.ZodString>; operationId: z.ZodString; principal: z.ZodObject<{ principalId: z.ZodString; type: z.ZodEnum<["user", "agent", "service", "system"]>; ten...	Runtime schema for Execution Activity Request.
executionActivityResultExample	constant	const executionActivityResultExample: ExecutionActivityResult	Valid example value for Execution Activity Result.
executionActivityResultJsonSchema	constant	const executionActivityResultJsonSchema: JsonSchema	JSON Schema for Execution Activity Result.
executionActivityResultSchema	constant	const executionActivityResultSchema: z.ZodEffects<z.ZodObject<{ activityId: z.ZodString; status: z.ZodEnum<["completed", "failed", "timeout", "cancelled", "unknown"]>; executionId: z.ZodOptional<z.ZodString>; artifactRefs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; snapshotRef: z.ZodOptional<z.ZodString>; eventIds: z.ZodArray<z.ZodString, "many">; error: z.ZodOptional<z.ZodObject<{ code: z.ZodEnum<["EXECUTION...	Runtime schema for Execution Activity Result.
executionActivityStatusSchema	constant	const executionActivityStatusSchema: z.ZodEnum<["completed", "failed", "timeout", "cancelled", "unknown"]>	Runtime schema for Execution Activity Status.
workspaceExecutionActivityRequestExample	constant	const workspaceExecutionActivityRequestExample: ExecutionActivityRequest	Valid example value for Workspace Execution Activity Request.
workspaceOperationRequestJsonSchema	constant	const workspaceOperationRequestJsonSchema: JsonSchema	JSON Schema for Workspace Operation Request.
workspaceOperationRequestSchema	constant	const workspaceOperationRequestSchema: z.ZodUnion<[z.ZodObject<{ workspaceId: z.ZodString; principal: z.ZodObject<{ principalId: z.ZodString; type: z.ZodEnum<["user", "agent", "service", "system"]>; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodOptional<z.ZodString>; agentId: z.ZodOptional<z.ZodString>; roles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; permissionScopes: z.ZodArray<z.ZodString, "many">; m...	Runtime schema for Workspace Operation Request.
validateExecutionActivityRequest	function	validateExecutionActivityRequest(input: unknown): ExecutionActivityRequest	Validate Execution Activity Request function with 1 public call signature; parameters and return types are listed below.
validateExecutionActivityResult	function	validateExecutionActivityResult(input: unknown): ExecutionActivityResult	Validate Execution Activity Result function with 1 public call signature; parameters and return types are listed below.
validateWorkspaceOperationRequest	function	validateWorkspaceOperationRequest(input: unknown): WorkspaceOperationRequest	Validate Workspace Operation Request function with 1 public call signature; parameters and return types are listed below.

executionActivityJsonSchemas

Execution Activity JSON Schemas constant exported by the modules/execution-activities/index module.

• Kind: constant
• Import: import { executionActivityJsonSchemas } from '@codesoul-co/hypha-core';
• Source module: modules/execution-activities/index

Declaration

export declare const executionActivityJsonSchemas: Record<string, JsonSchema>;

executionActivityRequestExample

Valid example value for Execution Activity Request.

• Kind: constant
• Import: import { executionActivityRequestExample } from '@codesoul-co/hypha-core';
• Source module: modules/execution-activities/index

Declaration

export declare const executionActivityRequestExample: ExecutionActivityRequest;

executionActivityRequestJsonSchema

JSON Schema for Execution Activity Request.

• Kind: constant
• Import: import { executionActivityRequestJsonSchema } from '@codesoul-co/hypha-core';
• Source module: modules/execution-activities/index

Declaration

export declare const executionActivityRequestJsonSchema: JsonSchema;

executionActivityRequestSchema

Runtime schema for Execution Activity Request.

• Kind: constant
• Import: import { executionActivityRequestSchema } from '@codesoul-co/hypha-core';
• Source module: modules/execution-activities/index

Declaration

// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const executionActivityRequestSchema: (typeof import('@codesoul-co/hypha-core'))['executionActivityRequestSchema'];

This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.

executionActivityResultExample

Valid example value for Execution Activity Result.

• Kind: constant
• Import: import { executionActivityResultExample } from '@codesoul-co/hypha-core';
• Source module: modules/execution-activities/index

Declaration

export declare const executionActivityResultExample: ExecutionActivityResult;

executionActivityResultJsonSchema

JSON Schema for Execution Activity Result.

• Kind: constant
• Import: import { executionActivityResultJsonSchema } from '@codesoul-co/hypha-core';
• Source module: modules/execution-activities/index

Declaration

export declare const executionActivityResultJsonSchema: JsonSchema;

executionActivityResultSchema

Runtime schema for Execution Activity Result.

• Kind: constant
• Import: import { executionActivityResultSchema } from '@codesoul-co/hypha-core';
• Source module: modules/execution-activities/index

Declaration

// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const executionActivityResultSchema: (typeof import('@codesoul-co/hypha-core'))['executionActivityResultSchema'];

This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.

executionActivityStatusSchema

Runtime schema for Execution Activity Status.

• Kind: constant
• Import: import { executionActivityStatusSchema } from '@codesoul-co/hypha-core';
• Source module: modules/execution-activities/index

Declaration

export declare const executionActivityStatusSchema: z.ZodEnum<["completed", "failed", "timeout", "cancelled", "unknown"]>;

workspaceExecutionActivityRequestExample

Valid example value for Workspace Execution Activity Request.

• Kind: constant
• Import: import { workspaceExecutionActivityRequestExample } from '@codesoul-co/hypha-core';
• Source module: modules/execution-activities/index

Declaration

export declare const workspaceExecutionActivityRequestExample: ExecutionActivityRequest;

workspaceOperationRequestJsonSchema

JSON Schema for Workspace Operation Request.

• Kind: constant
• Import: import { workspaceOperationRequestJsonSchema } from '@codesoul-co/hypha-core';
• Source module: modules/execution-activities/index

Declaration

export declare const workspaceOperationRequestJsonSchema: JsonSchema;

workspaceOperationRequestSchema

Runtime schema for Workspace Operation Request.

• Kind: constant
• Import: import { workspaceOperationRequestSchema } from '@codesoul-co/hypha-core';
• Source module: modules/execution-activities/index

Declaration

// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const workspaceOperationRequestSchema: (typeof import('@codesoul-co/hypha-core'))['workspaceOperationRequestSchema'];

This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.

validateExecutionActivityRequest

Validate Execution Activity Request function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateExecutionActivityRequest } from '@codesoul-co/hypha-core';
• Source module: modules/execution-activities/index

Declaration

export declare function validateExecutionActivityRequest(input: unknown): ExecutionActivityRequest;

Call signature

validateExecutionActivityRequest(input: unknown): ExecutionActivityRequest

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: ExecutionActivityRequest
• Description: The return contract is defined by the type shown above.

validateExecutionActivityResult

Validate Execution Activity Result function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateExecutionActivityResult } from '@codesoul-co/hypha-core';
• Source module: modules/execution-activities/index

Declaration

export declare function validateExecutionActivityResult(input: unknown): ExecutionActivityResult;

Call signature

validateExecutionActivityResult(input: unknown): ExecutionActivityResult

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: ExecutionActivityResult
• Description: The return contract is defined by the type shown above.

validateWorkspaceOperationRequest

Validate Workspace Operation Request function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateWorkspaceOperationRequest } from '@codesoul-co/hypha-core';
• Source module: modules/execution-activities/index

Declaration

export declare function validateWorkspaceOperationRequest(input: unknown): WorkspaceOperationRequest;

Call signature

validateWorkspaceOperationRequest(input: unknown): WorkspaceOperationRequest

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: WorkspaceOperationRequest
• Description: The return contract is defined by the type shown above.