@solidxai/core 0.1.12 → 0.1.13-beta.10

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

@@ -0,0 +1,53 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsInt, IsOptional, IsString, IsNotEmpty, IsDate } from 'class-validator';
+
+export class UpdateWorkflowSecretDto {
+    @IsOptional()
+    @IsInt()
+    id: number;
+
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Global secret key used in workflow expressions, for example smtp.password." })
+    key: string;
+
+    @IsNotEmpty()
+    @IsOptional()
+    @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()
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Plain value supplied by an admin. It is encrypted before storage." })
+    value: string;
+
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "How the decrypted value should be coerced for workflow runtime usage." })
+    valueType: string;
+
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Secret lifecycle status." })
+    status: string;
+
+    @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/update-workflow-step-execution.dto.ts

@@ -0,0 +1,132 @@
+import { IsInt,IsOptional, IsString, IsNotEmpty, IsDate, IsJSON } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
+
+export class UpdateWorkflowStepExecutionDto {
+    @IsOptional()
+    @IsInt()
+    id: number;
+
+    @IsNotEmpty()
+    @IsOptional()
+    @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()
+    @IsOptional()
+    @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()
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Broad node category." })
+    nodeKind: string;
+
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Registered node type id such as log.write, http.request, if, forEach, or parallel." })
+    nodeType: string;
+
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Current step execution status." })
+    status: string;
+
+    @IsNotEmpty()
+    @IsOptional()
+    @IsInt()
+    @ApiProperty({ description: "Current attempt number for this step execution." })
+    attemptNumber: number;
+
+    @IsOptional()
+    @IsInt()
+    @ApiProperty({ description: "Number of retries attempted for this step." })
+    retryCount: number;
+
+    @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/update-workflow-trigger-execution.dto.ts

@@ -0,0 +1,122 @@
+import { IsInt,IsOptional, IsString, IsNotEmpty, IsBoolean, IsDate, IsJSON } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
+
+export class UpdateWorkflowTriggerExecutionDto {
+    @IsOptional()
+    @IsInt()
+    id: number;
+
+    @IsNotEmpty()
+    @IsOptional()
+    @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()
+    @IsOptional()
+    @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()
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Registered trigger type id or broad trigger category." })
+    triggerType: string;
+
+    @IsNotEmpty()
+    @IsOptional()
+    @IsString()
+    @ApiProperty({ description: "Current trigger execution status." })
+    status: string;
+
+    @IsOptional()
+    @IsBoolean()
+    @ApiProperty({ description: "Whether this trigger evaluation matched and should start a workflow execution." })
+    matched: boolean;
+
+    @IsNotEmpty()
+    @IsOptional()
+    @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/validate-workflow-definition.dto.ts

@@ -0,0 +1,3 @@
+export class ValidateWorkflowDefinitionDto {
+  definitionYaml!: string;
+}

package/src/entities/common.entity.ts

@@ -25,6 +25,30 @@ export abstract class CommonEntity {
     @Column({ name: 'published_at', default: null, nullable: true, transformer: LocalDateTimeTransformer })
     publishedAt: Date;
 
+    // Optional (not just nullable) because legacy tables (see LegacyCommonEntityWithExistingId)
+    // don't carry these versioning columns at all. CRUDService<T extends CommonEntity> is
+    // otherwise used for both plain and legacy entities, so these must stay structurally
+    // satisfiable by a type that never declares them.
+    @Expose()
+    @Column({ name: 'is_published', default: false })
+    @Index()
+    isPublished?: boolean;
+
+    @Expose()
+    @Column({ name: 'is_latest', default: true })
+    @Index()
+    isLatest?: boolean;
+
+    @Expose()
+    @Column({ type: "int", name: 'initial_entity_version_id', default: null, nullable: true })
+    @Index()
+    initialEntityVersionId?: number;
+
+    @Expose()
+    @Column({ name: 'published_tracker', default: "na" })
+    @Index()
+    publishedTracker?: string;
+
     @Expose()
     @Column({ type: "varchar", name: 'locale_name', default: null })
     localeName: string;

package/src/entities/user.entity.ts

@@ -5,6 +5,23 @@ import { UserViewMetadata } from 'src/entities/user-view-metadata.entity'
 import { UserApiKey } from 'src/entities/user-api-key.entity'
 import { Exclude, Expose } from "class-transformer";
 
+/**
+ * Serialization is locked down twice over, and both halves are load-bearing:
+ *
+ * - The class-level `@Exclude()` below makes User itself an allowlist: only `@Expose()`d
+ *   properties are serialized.
+ * - Every other property additionally carries its own `@Exclude()`. That looks redundant
+ *   here, and for `User` it is - but class-transformer resolves the *class-level* strategy
+ *   with a direct lookup on the exact constructor (MetadataStorage.getStrategy), so a
+ *   subclass inherits nothing and falls back to `exposeAll`. Since this entity is a
+ *   `@TableInheritance` root that consuming projects extend (see
+ *   IExtensionUserCreationProvider), an extension user that forgets its own `@Exclude()`
+ *   would otherwise serialize the password hash and every OAuth/verification token.
+ *   Property-level metadata *is* walked up the prototype chain, so the per-property
+ *   decorators are what actually protect subclasses.
+ *
+ * Keep both. Adding a new column? Give it `@Expose()` or `@Exclude()` - never neither.
+ */
 @Entity("ss_user")
 @TableInheritance({ column: { type: "varchar", name: "type", default: "User" } })
 @Exclude()
@@ -30,7 +47,7 @@ export class User extends CommonEntity {
     mobile: string;
 
     @Column({ type: "varchar", nullable: true })
-    // don't send to client
+    @Exclude()
     password: string;
 
     @Column({ nullable: true, default: true })
@@ -38,67 +55,67 @@ export class User extends CommonEntity {
     forcePasswordChange: boolean = true;
 
     @Column({ type: "varchar", default: "local" })
-    // don't send to client
+    @Exclude()
     lastLoginProvider: string = "local";
 
     @Column({ type: "varchar", nullable: true })
-    // don't send to client (test)
+    @Exclude()
     accessCode: string;
 
     @Column({ type: "varchar", nullable: true })
-    // don't send to client
+    @Exclude()
     googleAccessToken: string;
 
     @Column({ type: "varchar", nullable: true })
-    // don't send to client
+    @Exclude()
     googleId: string;
 
     @Column({ type: "varchar", nullable: true })
-    // don't send to client
+    @Exclude()
     googleProfilePicture: string;
 
     @Column({ type: "varchar", nullable: true })
-    // don't send to client
+    @Exclude()
     facebookId: string;
 
     @Column({ type: "varchar", nullable: true })
-    // don't send to client
+    @Exclude()
     facebookAccessToken: string;
 
     @Column({ type: "varchar", nullable: true })
-    // don't send to client
+    @Exclude()
     facebookProfilePicture: string;
 
     @Column({ type: "varchar", nullable: true })
-    // don't send to client
+    @Exclude()
     appleId: string;
 
     @Column({ type: "varchar", nullable: true })
-    // don't send to client
+    @Exclude()
     appleAccessToken: string;
 
     @Column({ type: "varchar", nullable: true })
-    // don't send to client
+    @Exclude()
     microsoftId: string;
 
     @Column({ type: "varchar", nullable: true })
-    // don't send to client
+    @Exclude()
     microsoftAccessToken: string;
 
     @Column({ type: "varchar", nullable: true })
-    // don't send to client
+    @Exclude()
     microsoftProfilePicture: string;
 
     @Column({ type: "varchar", nullable: true })
-    // don't send to client
+    @Exclude()
     microsoftActiveDirectoryId: string;
 
     @Column({ type: "varchar", nullable: true })
-    // don't send to client
+    @Exclude()
     microsoftActiveDirectoryAccessToken: string;
 
     @Column({ type: "varchar", nullable: true })
-    // don't send to client
+    @Exclude()
     microsoftActiveDirectoryProfilePicture: string;
 
     @Index()
@@ -107,63 +124,63 @@ export class User extends CommonEntity {
     active: boolean = true;
 
     @Column({ nullable: true })
-    // don't send to client
+    @Exclude()
     forgotPasswordConfirmedAt: Date;
 
     @Column({ type: "varchar", nullable: true })
-    // don't send to client
+    @Exclude()
     verificationTokenOnForgotPassword: string;
 
     @Column({ nullable: true })
-    // don't send to client
+    @Exclude()
     verificationTokenOnForgotPasswordExpiresAt: Date;
 
     @Column({ nullable: true })
-    // don't send to client
+    @Exclude()
     emailVerifiedOnRegistrationAt: Date;
 
     @Column({ type: "varchar", nullable: true })
-    // don't send to client
+    @Exclude()
     emailVerificationTokenOnRegistration: string;
 
     @Column({ nullable: true })
-    // don't send to client
+    @Exclude()
     emailVerificationTokenOnRegistrationExpiresAt: Date;
 
     @Column({ nullable: true })
-    // don't send to client
+    @Exclude()
     mobileVerifiedOnRegistrationAt: Date;
 
     @Column({ type: "varchar", nullable: true })
-    // don't send to client
+    @Exclude()
     mobileVerificationTokenOnRegistration: string;
 
     @Column({ nullable: true })
-    // don't send to client
+    @Exclude()
     mobileVerificationTokenOnRegistrationExpiresAt: Date;
 
     @Column({ nullable: true })
-    // don't send to client
+    @Exclude()
     emailVerifiedOnLoginAt: Date;
 
     @Column({ type: "varchar", nullable: true })
-    // don't send to client
+    @Exclude()
     emailVerificationTokenOnLogin: string;
 
     @Column({ nullable: true })
-    // don't send to client
+    @Exclude()
     emailVerificationTokenOnLoginExpiresAt: Date;
 
     @Column({ nullable: true })
-    // don't send to client
+    @Exclude()
     mobileVerifiedOnLoginAt: Date;
 
     @Column({ type: "varchar", nullable: true })
-    // don't send to client
+    @Exclude()
     mobileVerificationTokenOnLogin: string;
 
     @Column({ nullable: true })
-    // don't send to client
+    @Exclude()
     mobileVerificationTokenOnLoginExpiresAt: Date;
 
     @Column({ type: "varchar", nullable: true })
@@ -176,18 +193,18 @@ export class User extends CommonEntity {
     roles: RoleMetadata[];
 
     @OneToMany(() => UserViewMetadata, userViewMetadata => userViewMetadata.user, { cascade: true })
-    // don't send to client
+    @Exclude()
     userViewMetadata: UserViewMetadata[];
 
-    // dont send to client
+    @Exclude()
     @Column({ type: "varchar", default: "bcrypt" })
     passwordScheme: string;
 
-    // dont send to client
+    @Exclude()
     @Column({ type: "int", default: 1 })
     passwordSchemeVersion: number;
 
-    // dont send to client
+    @Exclude()
     @Column({ nullable: true })
     rehashedAt: Date;
 

package/src/entities/workflow-definition.entity.ts

@@ -0,0 +1,43 @@
+import { CommonEntity } from 'src/entities/common.entity';
+import { ModuleMetadata } from 'src/entities/module-metadata.entity';
+import { Entity, Column, Index, JoinColumn, ManyToOne } from 'typeorm';
+
+@Entity('ss_workflow_definition')
+export class WorkflowDefinition extends CommonEntity {
+    @Index({ unique: true })
+    @Column({ type: "varchar" })
+    key: string;
+
+    @Index()
+    @ManyToOne(() => ModuleMetadata, { onDelete: "CASCADE", nullable: false })
+    @JoinColumn()
+    moduleMetadata: ModuleMetadata;
+
+    @Index()
+    @Column({ type: "varchar" })
+    displayName: string;
+
+    @Index()
+    @Column({ type: "varchar", nullable: true })
+    namespace: string;
+
+    @Column({ type: "text", nullable: true })
+    description: string;
+
+    @Index()
+    @Column({ type: "varchar", default: "draft" })
+    status: string = "draft";
+
+    @Column({ type: "varchar", nullable: true })
+    definitionVersion: string;
+
+    @Index()
+    @Column({ type: "varchar", nullable: true })
+    definitionChecksum: string;
+
+    @Column({ name: "definition_yaml", type: "text", nullable: true})
+    definitionYaml: string;
+
+    @Column({ type: "simple-json", nullable: true })
+    tags: any;
+}

package/src/entities/workflow-execution-artifact.entity.ts

@@ -0,0 +1,72 @@
+import { CommonEntity } from 'src/entities/common.entity';
+import { Entity, Column, Index, JoinColumn, ManyToOne } from 'typeorm';
+import { WorkflowExecution } from './workflow-execution.entity';
+import { WorkflowStepExecution } from './workflow-step-execution.entity'
+
+@Entity('ss_workflow_execution_artifact')
+export class WorkflowExecutionArtifact extends CommonEntity {
+    @Index({ unique: true })
+    @Column({ type: "varchar" })
+    artifactKey: string;
+
+    @Index()
+    @ManyToOne(() => WorkflowExecution, { onDelete: "CASCADE", nullable: false })
+    @JoinColumn()
+    workflowExecution: WorkflowExecution;
+
+    @Index()
+    @ManyToOne(() => WorkflowStepExecution, { onDelete: "CASCADE", nullable: true })
+    @JoinColumn()
+    workflowStepExecution: WorkflowStepExecution;
+
+    @Index()
+    @Column({ type: "varchar" })
+    name: string;
+
+    @Column({ type: "text", nullable: true })
+    description: string;
+
+    @Index()
+    @Column({ type: "varchar", default: "payload" })
+    artifactType: string = "payload";
+
+    @Index()
+    @Column({ type: "varchar", nullable: true })
+    nodeId: string;
+
+    @Index()
+    @Column({ type: "varchar", nullable: true })
+    nodeType: string;
+
+    @Index()
+    @Column({ type: "varchar", nullable: true })
+    storageProviderKey: string;
+
+    @Column({ type: "text", nullable: true })
+    uri: string;
+
+    @Index()
+    @Column({ type: "varchar", nullable: true })
+    fileName: string;
+
+    @Index()
+    @Column({ type: "varchar", nullable: true })
+    mimeType: string;
+
+    @Column({ type: "bigint", nullable: true })
+    sizeBytes: bigint;
+
+    @Index()
+    @Column({ type: "varchar", nullable: true })
+    checksum: string;
+
+    @Index()
+    @Column({ type: "timestamp", nullable: true })
+    producedAt: Date;
+
+    @Column({ type: "simple-json", nullable: true })
+    payload: any;
+
+    @Column({ type: "simple-json", nullable: true })
+    metadata: any;
+}