@solidxai/core 0.1.12 → 0.1.13-beta.2

package/src/dtos/create-workflow-execution-log.dto.ts

@@ -0,0 +1,80 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsString } from 'class-validator';
+import { IsNotEmpty, IsInt, IsOptional, IsDate, IsJSON } from 'class-validator';
+
+export class CreateWorkflowExecutionLogDto {
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty({ description: "Stable unique key for this workflow execution log entry." })
+    logKey: string;
+
+    @IsOptional()
+    @IsInt()
+    @ApiProperty({ description: "Workflow execution this log entry belongs to." })
+    workflowExecutionId: number;
+
+    @IsString()
+    @IsOptional()
+    @ApiProperty({ description: "Workflow execution this log entry belongs to." })
+    workflowExecutionUserKey: string;
+
+    @IsOptional()
+    @IsInt()
+    @ApiProperty({ description: "Optional step execution this log entry belongs to when the log is node-scoped." })
+    workflowStepExecutionId: number;
+
+    @IsString()
+    @IsOptional()
+    @ApiProperty({ description: "Optional step execution this log entry belongs to when the log is node-scoped." })
+    workflowStepExecutionUserKey: string;
+
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty({ description: "Log severity level." })
+    level: string = "info";
+
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty({ description: "Human-readable log message." })
+    message: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Structured event type such as execution.started, step.failed, or retry.scheduled." })
+    eventType: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Source component or runtime subsystem that emitted the log entry." })
+    source: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Workflow node id associated with this log entry, when applicable." })
+    nodeId: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Registered node type associated with this log entry, when applicable." })
+    nodeType: string;
+
+    @IsOptional()
+    @IsInt()
+    @ApiProperty({ description: "Monotonic ordering number for log entries within the execution." })
+    sequenceNumber: number;
+
+    @IsNotEmpty()
+    @IsDate()
+    @ApiProperty({ description: "Timestamp when the log entry was emitted." })
+    occurredAt: Date;
+
+    @IsOptional()
+    @IsJSON()
+    @ApiProperty({ description: "Structured context for this log entry." })
+    context: any;
+
+    @IsOptional()
+    @IsJSON()
+    @ApiProperty({ description: "Additional metadata captured with this log entry." })
+    metadata: any;
+}

package/src/dtos/create-workflow-execution.dto.ts

@@ -0,0 +1,137 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsInt } from 'class-validator';
+import { IsOptional } from 'class-validator';
+import { IsString, IsNotEmpty, IsDate, IsJSON, ValidateNested, IsArray } from 'class-validator';
+import { Type } from 'class-transformer';
+import { UpdateWorkflowStepExecutionDto } from 'src/dtos/update-workflow-step-execution.dto';
+import { UpdateWorkflowExecutionLogDto } from 'src/dtos/update-workflow-execution-log.dto';
+import { UpdateWorkflowExecutionArtifactDto } from 'src/dtos/update-workflow-execution-artifact.dto';
+
+export class CreateWorkflowExecutionDto {
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty({ description: "System-generated readable execution identifier." })
+    executionIdentifier: string;
+
+    @IsOptional()
+    @IsInt()
+    @ApiProperty({ description: "Workflow definition used to create this execution." })
+    workflowDefinitionId: number;
+
+    @IsString()
+    @IsOptional()
+    @ApiProperty({ description: "Workflow definition used to create this execution." })
+    workflowDefinitionUserKey: string;
+
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty({ description: "Snapshot of the workflow definition key for easier querying." })
+    workflowKey: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Snapshot of the workflow display name at execution time." })
+    workflowDisplayName: string;
+
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty({ description: "Current workflow execution status." })
+    status: string = "created";
+
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty({ description: "Mechanism that started this workflow execution." })
+    triggerType: string = "manual";
+
+    @IsOptional()
+    @IsDate()
+    @ApiProperty({ description: "Execution start timestamp." })
+    startedAt: Date;
+
+    @IsOptional()
+    @IsDate()
+    @ApiProperty({ description: "Execution finish timestamp." })
+    finishedAt: Date;
+
+    @IsOptional()
+    @ApiProperty({ description: "Execution duration in milliseconds." })
+    durationMs: bigint;
+
+    @IsOptional()
+    @IsJSON()
+    @ApiProperty({ description: "Runtime inputs supplied to the workflow execution." })
+    inputPayload: any;
+
+    @IsOptional()
+    @IsJSON()
+    @ApiProperty({ description: "Flow-level outputs produced by the workflow execution." })
+    outputPayload: any;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Definition version used by this execution." })
+    definitionVersion: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Definition checksum used by this execution." })
+    definitionChecksum: string;
+
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty({ description: "Exact workflow YAML definition used for this execution." })
+    definitionSnapshot: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Human-readable execution failure summary." })
+    errorSummary: string;
+
+    @IsOptional()
+    @IsJSON()
+    @ApiProperty({ description: "Structured execution error payload." })
+    errorDetails: any;
+
+    @IsOptional()
+    @ApiProperty({ description: "User or actor id that requested the execution, if available." })
+    requestedByUserId: bigint;
+
+    @IsArray()
+    @ValidateNested({ each : true })
+    @Type(() => UpdateWorkflowStepExecutionDto)
+    @IsOptional()
+    workflowStepExecutions: UpdateWorkflowStepExecutionDto[];
+
+    @IsOptional()
+    @IsArray()
+    workflowStepExecutionIds: number[];
+
+    @IsOptional()
+    workflowStepExecutionCommand: string;
+
+    @IsArray()
+    @ValidateNested({ each : true })
+    @Type(() => UpdateWorkflowExecutionLogDto)
+    @IsOptional()
+    workflowExecutionLogs: UpdateWorkflowExecutionLogDto[];
+
+    @IsOptional()
+    @IsArray()
+    workflowExecutionLogIds: number[];
+
+    @IsOptional()
+    workflowExecutionLogCommand: string;
+
+    @IsArray()
+    @ValidateNested({ each : true })
+    @Type(() => UpdateWorkflowExecutionArtifactDto)
+    @IsOptional()
+    workflowExecutionArtifacts: UpdateWorkflowExecutionArtifactDto[];
+
+    @IsOptional()
+    @IsArray()
+    workflowExecutionArtifactIds: number[];
+
+    @IsOptional()
+    workflowExecutionArtifactCommand: string;
+}

package/src/dtos/create-workflow-secret.dto.ts

@@ -0,0 +1,44 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsNotEmpty, IsOptional, IsString, IsDate } from 'class-validator';
+
+export class CreateWorkflowSecretDto {
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty({ description: "Global secret key used in workflow expressions, for example smtp.password." })
+    key: string;
+
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty({ description: "Human-facing secret name shown in the admin UI." })
+    displayName: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Operational notes describing where this secret is used." })
+    description: string;
+
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty({ description: "Plain value supplied by an admin. It is encrypted before storage." })
+    value: string;
+
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty({ description: "How the decrypted value should be coerced for workflow runtime usage." })
+    valueType: string = "string";
+
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty({ description: "Secret lifecycle status." })
+    status: string = "active";
+
+    @IsOptional()
+    @IsDate()
+    @ApiProperty({ description: "When this secret was last rotated." })
+    lastRotatedAt: Date;
+
+    @IsOptional()
+    @IsDate()
+    @ApiProperty({ description: "When this secret was last resolved by workflow runtime." })
+    lastAccessedAt: Date;
+}

package/src/dtos/create-workflow-step-execution.dto.ts

@@ -0,0 +1,123 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsString } from 'class-validator';
+import { IsNotEmpty, IsInt, IsOptional, IsDate, IsJSON } from 'class-validator';
+
+export class CreateWorkflowStepExecutionDto {
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty({ description: "Stable unique key for this step execution, assigned by the runtime." })
+    stepExecutionKey: string;
+
+    @IsOptional()
+    @IsInt()
+    @ApiProperty({ description: "Parent workflow execution this step belongs to." })
+    workflowExecutionId: number;
+
+    @IsString()
+    @IsOptional()
+    @ApiProperty({ description: "Parent workflow execution this step belongs to." })
+    workflowExecutionUserKey: string;
+
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty({ description: "Node id from the workflow definition DSL." })
+    nodeId: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Human-readable node name captured at execution time." })
+    nodeName: string;
+
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty({ description: "Broad node category." })
+    nodeKind: string = "task";
+
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty({ description: "Registered node type id such as log.write, http.request, if, forEach, or parallel." })
+    nodeType: string;
+
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty({ description: "Current step execution status." })
+    status: string = "created";
+
+    @IsNotEmpty()
+    @IsInt()
+    @ApiProperty({ description: "Current attempt number for this step execution." })
+    attemptNumber: number = 1;
+
+    @IsOptional()
+    @IsInt()
+    @ApiProperty({ description: "Number of retries attempted for this step." })
+    retryCount: number = 0;
+
+    @IsOptional()
+    @IsInt()
+    @ApiProperty({ description: "Maximum retry count resolved for this step." })
+    maxRetries: number;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Parent control or subflow node id when this step is nested." })
+    parentNodeId: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Parent step execution key for nested runtime structures." })
+    parentStepExecutionKey: string;
+
+    @IsOptional()
+    @IsInt()
+    @ApiProperty({ description: "Traversal or scheduling sequence number within the workflow execution." })
+    sequenceNumber: number;
+
+    @IsOptional()
+    @IsDate()
+    @ApiProperty({ description: "Step start timestamp." })
+    startedAt: Date;
+
+    @IsOptional()
+    @IsDate()
+    @ApiProperty({ description: "Step finish timestamp." })
+    finishedAt: Date;
+
+    @IsOptional()
+    @ApiProperty({ description: "Step duration in milliseconds." })
+    durationMs: bigint;
+
+    @IsOptional()
+    @ApiProperty({ description: "Timeout resolved for this step in milliseconds." })
+    timeoutMs: bigint;
+
+    @IsOptional()
+    @IsJSON()
+    @ApiProperty({ description: "Input payload resolved for this step execution." })
+    inputPayload: any;
+
+    @IsOptional()
+    @IsJSON()
+    @ApiProperty({ description: "Output payload produced by this step execution." })
+    outputPayload: any;
+
+    @IsOptional()
+    @IsJSON()
+    @ApiProperty({ description: "Scoped runtime context used while executing this step." })
+    runtimeContext: any;
+
+    @IsOptional()
+    @IsJSON()
+    @ApiProperty({ description: "Snapshot of the workflow node definition used for this step execution." })
+    nodeSnapshot: any;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Short human-readable error summary for failed steps." })
+    errorSummary: string;
+
+    @IsOptional()
+    @IsJSON()
+    @ApiProperty({ description: "Structured error details captured for failed steps." })
+    errorDetails: any;
+}

package/src/dtos/create-workflow-trigger-execution.dto.ts

@@ -0,0 +1,114 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsString } from 'class-validator';
+import { IsNotEmpty, IsInt, IsOptional, IsBoolean, IsDate, IsJSON } from 'class-validator';
+
+export class CreateWorkflowTriggerExecutionDto {
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty({ description: "Stable unique key for this trigger execution attempt." })
+    triggerExecutionKey: string;
+
+    @IsOptional()
+    @IsInt()
+    @ApiProperty({ description: "Workflow definition whose trigger fired or was evaluated." })
+    workflowDefinitionId: number;
+
+    @IsString()
+    @IsOptional()
+    @ApiProperty({ description: "Workflow definition whose trigger fired or was evaluated." })
+    workflowDefinitionUserKey: string;
+
+    @IsOptional()
+    @IsInt()
+    @ApiProperty({ description: "Workflow execution created by this trigger, when a run was started." })
+    workflowExecutionId: number;
+
+    @IsString()
+    @IsOptional()
+    @ApiProperty({ description: "Workflow execution created by this trigger, when a run was started." })
+    workflowExecutionUserKey: string;
+
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty({ description: "Trigger id from the workflow definition DSL." })
+    triggerId: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Human-readable trigger name captured at execution time." })
+    triggerName: string;
+
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty({ description: "Registered trigger type id or broad trigger category." })
+    triggerType: string;
+
+    @IsNotEmpty()
+    @IsString()
+    @ApiProperty({ description: "Current trigger execution status." })
+    status: string = "received";
+
+    @IsOptional()
+    @IsBoolean()
+    @ApiProperty({ description: "Whether this trigger evaluation matched and should start a workflow execution." })
+    matched: boolean = false;
+
+    @IsNotEmpty()
+    @IsDate()
+    @ApiProperty({ description: "Timestamp when the trigger fired or was received." })
+    firedAt: Date;
+
+    @IsOptional()
+    @IsDate()
+    @ApiProperty({ description: "Timestamp when trigger processing started." })
+    startedAt: Date;
+
+    @IsOptional()
+    @IsDate()
+    @ApiProperty({ description: "Timestamp when trigger processing finished." })
+    finishedAt: Date;
+
+    @IsOptional()
+    @ApiProperty({ description: "Trigger processing duration in milliseconds." })
+    durationMs: bigint;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Source system, scheduler, webhook endpoint, or event bus that produced the trigger." })
+    source: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "External correlation id for linking trigger attempts to upstream events." })
+    correlationId: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Optional idempotency key used to prevent duplicate trigger handling." })
+    idempotencyKey: string;
+
+    @IsOptional()
+    @IsJSON()
+    @ApiProperty({ description: "Trigger payload, request body, schedule context, or event data." })
+    payload: any;
+
+    @IsOptional()
+    @IsJSON()
+    @ApiProperty({ description: "Snapshot of the trigger definition used for this trigger execution." })
+    triggerSnapshot: any;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Short human-readable error summary for failed trigger executions." })
+    errorSummary: string;
+
+    @IsOptional()
+    @IsJSON()
+    @ApiProperty({ description: "Structured error details captured for failed trigger executions." })
+    errorDetails: any;
+
+    @IsOptional()
+    @IsJSON()
+    @ApiProperty({ description: "Additional trigger execution metadata." })
+    metadata: any;
+}

package/src/dtos/execute-workflow.dto.ts

@@ -0,0 +1,6 @@
+export class ExecuteWorkflowDto {
+  input?: Record<string, any>;
+  variables?: Record<string, any>;
+  triggerType?: string;
+  requestedByUserId?: number;
+}

package/src/dtos/update-workflow-definition.dto.ts

@@ -0,0 +1,67 @@
+import { IsInt,IsOptional, IsString, IsNotEmpty, IsJSON } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
+
+export class UpdateWorkflowDefinitionDto {
+    @IsOptional()
+    @IsInt()
+    id: number;
+
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Stable workflow key used as the metadata identity and developer-facing workflow identifier." })
+    key: string;
+
+    @IsOptional()
+    @IsInt()
+    @ApiProperty({ description: "Owning SolidX module/package used for metadata persistence and distribution." })
+    moduleMetadataId: number;
+
+    @IsString()
+    @IsOptional()
+    @ApiProperty({ description: "Owning SolidX module/package used for metadata persistence and distribution." })
+    moduleMetadataUserKey: string;
+
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Human-facing workflow name shown in builder and execution screens." })
+    displayName: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Optional dot-path grouping for workflows, such as ops.monitoring." })
+    namespace: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Workflow description and operational notes." })
+    description: string;
+
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Workflow lifecycle status." })
+    status: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Human-managed or seed-managed version string for the current workflow definition." })
+    definitionVersion: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Checksum of the canonical definition YAML for change detection and execution traceability." })
+    definitionChecksum: string;
+
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Canonical workflow DSL YAML used for sharing, seeding, validation, and execution." })
+    definitionYaml: string;
+
+    @IsOptional()
+    @IsJSON()
+    @ApiProperty({ description: "Optional array of tags for categorizing and searching workflows." })
+    tags: any;
+}

package/src/dtos/update-workflow-execution-artifact.dto.ts

@@ -0,0 +1,105 @@
+import { IsInt,IsOptional, IsString, IsNotEmpty, IsDate, IsJSON } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
+
+export class UpdateWorkflowExecutionArtifactDto {
+    @IsOptional()
+    @IsInt()
+    id: number;
+
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Stable unique key for this execution artifact." })
+    artifactKey: string;
+
+    @IsOptional()
+    @IsInt()
+    @ApiProperty({ description: "Workflow execution this artifact belongs to." })
+    workflowExecutionId: number;
+
+    @IsString()
+    @IsOptional()
+    @ApiProperty({ description: "Workflow execution this artifact belongs to." })
+    workflowExecutionUserKey: string;
+
+    @IsOptional()
+    @IsInt()
+    @ApiProperty({ description: "Optional step execution that produced this artifact." })
+    workflowStepExecutionId: number;
+
+    @IsString()
+    @IsOptional()
+    @ApiProperty({ description: "Optional step execution that produced this artifact." })
+    workflowStepExecutionUserKey: string;
+
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Human-readable artifact name." })
+    name: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Optional artifact description." })
+    description: string;
+
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Artifact storage or payload category." })
+    artifactType: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Workflow node id that produced this artifact, when applicable." })
+    nodeId: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Registered node type that produced this artifact, when applicable." })
+    nodeType: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Storage provider key when this artifact is stored outside the database." })
+    storageProviderKey: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "External URI, storage path, or download URL for the artifact." })
+    uri: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Original or generated file name for file artifacts." })
+    fileName: string;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "MIME type for file or binary artifacts." })
+    mimeType: string;
+
+    @IsOptional()
+    @ApiProperty({ description: "Artifact size in bytes, when known." })
+    sizeBytes: bigint;
+
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Artifact checksum or content hash, when available." })
+    checksum: string;
+
+    @IsOptional()
+    @IsDate()
+    @ApiProperty({ description: "Timestamp when the artifact was produced." })
+    producedAt: Date;
+
+    @IsOptional()
+    @IsJSON()
+    @ApiProperty({ description: "Inline structured artifact payload for small DB-stored artifacts." })
+    payload: any;
+
+    @IsOptional()
+    @IsJSON()
+    @ApiProperty({ description: "Additional artifact metadata." })
+    metadata: any;
+}