如何在serverless.ts中配置Step Functions并解决类型缺失问题

由于官方@serverless/typescript包未包含serverless-step-functions插件对应的类型定义，你可以通过以下几种方式在serverless.ts中添加Step Functions配置：

方案一：扩展AWS类型（推荐） #

通过TypeScript模块扩展机制，为官方AWS接口补充stepFunctions字段的类型定义，既能获得类型提示，又能保证类型安全。

1. 在项目中创建类型声明文件（比如types/serverless.d.ts），添加以下内容：

import type { AWS } from '@serverless/typescript';

declare module '@serverless/typescript' {
  interface AWS {
    stepFunctions?: {
      stateMachines?: Record<string, {
        name?: string;
        definition: Record<string, any>; // 可根据需求细化为更精确的状态机结构类型
        role?: string;
        tags?: Record<string, string>;
        // 按需添加其他stepFunctions支持的配置字段
      }>;
    };
  }
}

如果需要更精准的状态机定义类型，可以参考AWS Step Functions官方结构细化definition：

type StateMachineState = 
  | { Type: 'Task'; Resource: string; Next?: string; End?: boolean }
  | { Type: 'Pass'; Next?: string; End?: boolean }
  | { Type: 'Wait'; Seconds?: number; Next?: string }
  // 可补充其他状态类型（Choice/Succeed/Fail/Parallel等）的定义
;

type StateMachineDefinition = {
  Comment?: string;
  StartAt: string;
  States: Record<string, StateMachineState>;
};

// 替换上述接口中的definition类型为StateMachineDefinition即可

2. 在你的serverless.ts中正常编写Step Functions配置：

import type { AWS } from '@serverless/typescript';
import { hello } from './src/functions';

const serverlessConfiguration: AWS = {
  service: 'serverless-typescript',
  frameworkVersion: '2',
  useDotenv: true,
  // 原有custom、plugins、provider等配置...
  functions: { hello },
  stepFunctions: {
    stateMachines: {
      demoStateMachine: {
        name: '${self:service}-${self:custom.stage}-demo-machine',
        definition: {
          Comment: '示例状态机',
          StartAt: 'InvokeHelloFunction',
          States: {
            InvokeHelloFunction: {
              Type: 'Task',
              Resource: 'arn:aws:lambda:${self:provider.region}:${aws:accountId}:function:${self:service}-${self:custom.stage}-hello',
              End: true
            }
          }
        },
        role: 'arn:aws:iam::${aws:accountId}:role/StateMachineExecutionRole'
      }
    }
  }
};

module.exports = serverlessConfiguration;

方案二：类型断言快速绕过检查 #

如果不需要严格的类型提示，仅需快速添加配置，可以用类型断言让TypeScript跳过类型校验：

import type { AWS } from '@serverless/typescript';
import { hello } from './src/functions';

const serverlessConfiguration = {
  // 原有所有配置...
  functions: { hello },
  stepFunctions: {
    stateMachines: {
      demoStateMachine: {
        name: '${self:service}-${self:custom.stage}-demo-machine',
        definition: {
          Comment: '示例状态机',
          StartAt: 'InvokeHelloFunction',
          States: {
            InvokeHelloFunction: {
              Type: 'Task',
              Resource: 'arn:aws:lambda:${self:provider.region}:${aws:accountId}:function:${self:service}-${self:custom.stage}-hello',
              End: true
            }
          }
        }
      }
    }
  }
} as AWS;

module.exports = serverlessConfiguration;

方案三：自定义完整配置类型 #

完全自定义包含Step Functions的配置类型，替代官方AWS类型：

import type { AWS as BaseAWS } from '@serverless/typescript';

interface StepFunctionsConfig {
  stateMachines: Record<string, {
    name?: string;
    definition: any; // 或使用方案一中的精确StateMachineDefinition类型
    role?: string;
    tags?: Record<string, string>;
  }>;
}

type AWSWithStepFunctions = BaseAWS & {
  stepFunctions?: StepFunctionsConfig;
};

const serverlessConfiguration: AWSWithStepFunctions = {
  // 原有配置...
  stepFunctions: {
    // 你的状态机配置
  }
};

module.exports = serverlessConfiguration;

内容的提问来源于stack exchange，提问作者zlZimon