@project-rwc/rwc/src/job/config.ts

Common types & utilities for Project RWC

import { JobPipelineStepConfigResErrorCode } from "./error"

export type JobPipelineStepConfig = {

}

export type JobPipelineStepConfigResError = {
    success: false
    error: {
        rwcErrorCode: JobPipelineStepConfigResErrorCode

        /**
         * A brief, PascalCase error code which describes the error.
         */
        nodeErrorCode?: string

        /**
         * A longer human-readable error message for debugging.
         */
        error?: string
    }
    
}

export type JobPipelineStepConfigResSuccess = {
    success: true

    /**
     * 128 bits of cryptographically secure random data, encoded as a hex string.
     * Used to access this job.
     * Keep this value a secret.
     */
    token: string
}

export type JobPipelineStepConfigRes = JobPipelineStepConfigResError | JobPipelineStepConfigResSuccess;