docs: jsdoc, plus String.raw for regex

Author: tstephen-nhs

packages/cdkConstructs/src/constructs/RestApiGateway/StateMachineEndpoint.ts

@@ -7,16 +7,23 @@ import {stateMachine200ResponseTemplate, stateMachineErrorResponseTemplate} from
 import {ExpressStateMachine} from "../StateMachine.js"
 
 export interface StateMachineEndpointProps {
+  /** Parent API resource under which the state machine endpoint is added. */
   parentResource: IResource
+  /** Path segment used to create the child API resource. */
   readonly resourceName: string
+  /** HTTP verb bound to the Step Functions integration. */
   readonly method: HttpMethod
+  /** Invocation role used by API Gateway when starting workflow executions. */
   restApiGatewayRole: IRole
+  /** State machine wrapper construct providing the target workflow ARN and integration target. */
   stateMachine: ExpressStateMachine
 }
 
+/** Adds an API Gateway resource/method that starts an Express Step Functions execution. */
 export class StateMachineEndpoint extends Construct {
   resource: IResource
 
+  /** Wires request and response mapping templates for JSON and FHIR payload flows. */
   public constructor(scope: Construct, id: string, props: StateMachineEndpointProps) {
     super(scope, id)
 
@@ -39,14 +46,14 @@ export class StateMachineEndpoint extends Construct {
         },
         {
           statusCode: "400",
-          selectionPattern: "^4\\d{2}.*",
+          selectionPattern: String.raw`^4\d{2}.*`,
           responseTemplates: {
             "application/json": stateMachineErrorResponseTemplate("400")
           }
         },
         {
           statusCode: "500",
-          selectionPattern: "^5\\d{2}.*",
+          selectionPattern: String.raw`^5\d{2}.*`,
           responseTemplates: {
             "application/json": stateMachineErrorResponseTemplate("500")
           }

packages/cdkConstructs/src/constructs/StateMachine.ts

@@ -22,10 +22,15 @@ import {Construct} from "constructs"
 import {CfnDeliveryStream} from "aws-cdk-lib/aws-kinesisfirehose"
 
 export interface StateMachineProps {
+  /** Stack name, used as prefix for resource naming and DNS records. */
   readonly stackName: string
+  /** Friendly state machine name used for both AWS resource and log naming. */
   readonly stateMachineName: string
+  /** Workflow definition chain rendered as the state machine definition body. */
   readonly definition: IChainable
+  /** Extra managed policies merged into the execution role when required. */
   readonly additionalPolicies?: Array<IManagedPolicy>
+  /** Retention period applied to the workflow CloudWatch log group. */
   readonly logRetentionInDays: number
   /**
    * Optional KMS key for encrypting CloudWatch Logs.
@@ -58,6 +63,7 @@ export class ExpressStateMachine extends Construct {
   public readonly executionPolicy: ManagedPolicy
   public readonly stateMachine: StateMachine
 
+  /** Provisions an Express Step Functions workflow with logging, tracing, and invoke permissions. */
   public constructor(scope: Construct, id: string, props: StateMachineProps) {
     super(scope, id)
 

packages/cdkConstructs/src/constructs/StateMachine/CatchAllErrorPass.ts

@@ -26,9 +26,12 @@ const severErrorOperationOutcome = `{% $string(
   }
 ) %}`
 
+/** Produces a fixed 500 FHIR OperationOutcome payload for unhandled workflow failures. */
 export class CatchAllErrorPass extends Construct {
+  /** Pass state returned by this construct for chaining in state machine definitions. */
   public readonly state
 
+  /** Creates a terminal-style error response payload without exposing internal exception detail. */
   public constructor(scope: Construct, id: string) {
     super(scope, id)