migrate generate-sam-template to typescript

Author: anthonyting

packages/aws-durable-execution-sdk-js-examples/package.json

@@ -36,7 +36,7 @@
     "copy-examples": "cp -r dist/examples/*.js dist/examples/*.js.map build/aws-durable-execution-sdk-js-examples",
     "copy-source": "mkdir -p build/source && cp -r src/examples/*.ts build/source/",
     "copy-catalog": "cp examples-catalog.json build/aws-durable-execution-sdk-js-examples/",
-    "generate-sam-template": "node scripts/generate-sam-template.js",
+    "generate-sam-template": "tsx scripts/generate-sam-template.ts",
     "test": "npm run unit-test",
     "test:integration": "NODE_ENV=integration jest --config jest.config.integration.js",
     "pretest-with-sdk-coverage": "node scripts/copy-sdk-source.js",

packages/aws-durable-execution-sdk-js-examples/rollup.config.mjs

@@ -7,6 +7,7 @@ import nodeResolve from "@rollup/plugin-node-resolve";
 import json from "@rollup/plugin-json";
 import commonJs from "@rollup/plugin-commonjs";
 import path from "path";
+import { fileURLToPath } from "url";
 
 const allExamplePaths = examplesCatalog.map((example) =>
   path.resolve(example.path),
@@ -43,6 +44,10 @@ export default defineConfig({
     typescript({
       // Disable incremental build to ensure examples catalog is parsed
       incremental: false,
+      tsconfig: path.resolve(
+        path.dirname(fileURLToPath(import.meta.url)),
+        "./tsconfig.build.json",
+      ),
     }),
     nodeResolve({
       preferBuiltins: true,

…/__tests__/generate-sam-template.test.ts …/__tests__/generate-sam-template.test.tspackages/aws-durable-execution-sdk-js-examples/src/__tests__/generate-sam-template.test.ts renamed to packages/aws-durable-execution-sdk-js-examples/scripts/__tests__/generate-sam-template.test.ts packages/aws-durable-execution-sdk-js-examples/src/__tests__/generate-sam-template.test.ts renamed to packages/aws-durable-execution-sdk-js-examples/scripts/__tests__/generate-sam-template.test.ts

@@ -1,9 +1,35 @@
-const {
+import {
   toPascalCase,
-  getExampleFiles,
   createFunctionResource,
   generateTemplate,
-} = require("../../scripts/generate-sam-template.js");
+  getExamplesCatalogJson,
+} from "../generate-sam-template";
+
+jest.mock("../generate-sam-template", () => ({
+  ...jest.requireActual("../generate-sam-template"),
+  getExamplesCatalogJson: jest.fn(() => [
+    {
+      name: "hello-world",
+      description: "A simple hello world example with no durable operations",
+      path: "aws-durable-execution-sdk-js/packages/aws-durable-execution-sdk-js-examples/src/examples/hello-world/hello-world.ts",
+      handler: "hello-world.handler",
+      durableConfig: {
+        ExecutionTimeout: 60,
+        RetentionPeriodInDays: 7,
+      },
+    },
+    {
+      name: "steps-with-retry",
+      description: "An example demonstrating retry functionality with steps",
+      path: "aws-durable-execution-sdk-js/packages/aws-durable-execution-sdk-js-examples/src/examples/step/steps-with-retry/steps-with-retry.ts",
+      handler: "steps-with-retry.handler",
+      durableConfig: {
+        ExecutionTimeout: 60,
+        RetentionPeriodInDays: 7,
+      },
+    },
+  ]),
+}));
 
 describe("generate-sam-template", () => {
   describe("toPascalCase", () => {
@@ -17,16 +43,10 @@ describe("generate-sam-template", () => {
 
   describe("createFunctionResource", () => {
     test("creates default function resource", () => {
-      const resource = createFunctionResource("hello-world", {
-        name: "Hello World",
-        description: "A simple hello world example with no durable operations",
-        path: "aws-durable-execution-sdk-js/packages/aws-durable-execution-sdk-js-examples/src/examples/hello-world/hello-world.ts",
-        handler: "hello-world.handler",
-        durableConfig: {
-          ExecutionTimeout: 60,
-          RetentionPeriodInDays: 7,
-        },
-      });
+      const resource = createFunctionResource(
+        "hello-world",
+        getExamplesCatalogJson()[0],
+      );
 
       expect(resource.Type).toBe("AWS::Serverless::Function");
       expect(resource.Properties.FunctionName).toBe("hello-world");
@@ -38,16 +58,10 @@ describe("generate-sam-template", () => {
     });
 
     test("creates function resource with custom config for steps-with-retry", () => {
-      const resource = createFunctionResource("steps-with-retry", {
-        name: "Steps With Retry",
-        description: "An example demonstrating retry functionality with steps",
-        path: "aws-durable-execution-sdk-js/packages/aws-durable-execution-sdk-js-examples/src/examples/step/steps-with-retry/steps-with-retry.ts",
-        handler: "steps-with-retry.handler",
-        durableConfig: {
-          ExecutionTimeout: 60,
-          RetentionPeriodInDays: 7,
-        },
-      });
+      const resource = createFunctionResource(
+        "steps-with-retry",
+        getExamplesCatalogJson()[1],
+      );
 
       expect(resource.Properties.FunctionName).toBe("steps-with-retry");
       expect(resource.Properties.MemorySize).toBe(256);

…xamples/scripts/generate-sam-template.js …xamples/scripts/generate-sam-template.tspackages/aws-durable-execution-sdk-js-examples/scripts/generate-sam-template.js renamed to packages/aws-durable-execution-sdk-js-examples/scripts/generate-sam-template.ts packages/aws-durable-execution-sdk-js-examples/scripts/generate-sam-template.js renamed to packages/aws-durable-execution-sdk-js-examples/scripts/generate-sam-template.ts

@@ -1,11 +1,11 @@
 #!/usr/bin/env node
 
-const fs = require("fs");
-const path = require("path");
-const yaml = require("js-yaml");
+import fs from "fs";
+import path from "path";
+import yaml from "js-yaml";
 
 // Configuration for different examples that need special settings
-const EXAMPLE_CONFIGS = {
+const EXAMPLE_CONFIGS: Record<string, any> = {
   "steps-with-retry": {
     memorySize: 256,
     timeout: 300,
@@ -29,90 +29,24 @@ const DEFAULT_CONFIG = {
 /**
  * Convert kebab-case filename to PascalCase resource name
  */
-function toPascalCase(filename) {
+function toPascalCase(filename: string) {
   return filename
     .split("-")
-    .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
+    .map((word: string) => word.charAt(0).toUpperCase() + word.slice(1))
     .join("");
 }
 
-/**
- * Get TypeScript files from src/examples directory
- */
-function getExampleFiles() {
-  const catalogPath = path.join(
-    __dirname,
-    "../src/utils/examples-catalog.json",
-  );
-
-  if (!fs.existsSync(catalogPath)) {
-    throw new Error(`Examples directory not found: ${catalogPath}`);
-  }
-
-  const catalog = JSON.parse(fs.readFileSync(catalogPath, "utf8"));
-
-  const exampleFiles = catalog.map((example) => example.name);
-
-  // Read all directories in examples
-  const entries = fs.readdirSync(examplesDir, { withFileTypes: true });
-
-  for (const entry of entries) {
-    // Skip non-directories and special directories
-    if (!entry.isDirectory() || entry.name.startsWith(".")) {
-      continue;
-    }
-
-    const dirPath = path.join(examplesDir, entry.name);
-    const subEntries = fs.readdirSync(dirPath, { withFileTypes: true });
-
-    // Check if this directory contains TypeScript files directly (standalone examples)
-    const directTsFiles = subEntries.filter(
-      (dirent) =>
-        dirent.isFile() &&
-        dirent.name.endsWith(".ts") &&
-        !dirent.name.includes(".test"),
-    );
-
-    if (directTsFiles.length > 0) {
-      // Standalone example directory
-      directTsFiles.forEach((file) => {
-        exampleFiles.push(path.basename(file.name, ".ts"));
-      });
-    } else {
-      // Nested structure - scan subdirectories
-      const subDirs = subEntries.filter((dirent) => dirent.isDirectory());
-
-      for (const subDir of subDirs) {
-        const subDirPath = path.join(dirPath, subDir.name);
-        const filesInSubDir = fs.readdirSync(subDirPath);
-
-        // Find TypeScript files (excluding test files)
-        const tsFiles = filesInSubDir.filter(
-          (file) => file.endsWith(".ts") && !file.includes(".test."),
-        );
-
-        // Add each example file (without .ts extension)
-        tsFiles.forEach((file) => {
-          exampleFiles.push(path.basename(file, ".ts"));
-        });
-      }
-    }
-  }
-
-  return exampleFiles.sort(); // Sort for consistent output
-}
-
 /**
  * Create a Lambda function resource configuration
  */
 function createFunctionResource(
-  resourceName,
-  catalog,
+  resourceName: string,
+  catalog: any,
   skipVerboseLogging = false,
 ) {
   const config = EXAMPLE_CONFIGS[resourceName] || DEFAULT_CONFIG;
 
-  const functionResource = {
+  const functionResource: Record<string, any> = {
     Type: "AWS::Serverless::Function",
     Properties: {
       FunctionName: resourceName,
@@ -145,10 +79,7 @@ function createFunctionResource(
   return functionResource;
 }
 
-/**
- * Generate the complete CloudFormation template
- */
-function generateTemplate(skipVerboseLogging = false) {
+function getExamplesCatalogJson() {
   const examplesCatalogPath = path.join(
     __dirname,
     "../src/utils/examples-catalog.json",
@@ -166,7 +97,16 @@ function generateTemplate(skipVerboseLogging = false) {
     throw new Error("No TypeScript example files found in src/examples");
   }
 
-  const template = {
+  return examplesCatalog;
+}
+
+/**
+ * Generate the complete CloudFormation template
+ */
+function generateTemplate(skipVerboseLogging = false) {
+  const examplesCatalog = getExamplesCatalogJson();
+
+  const template: Record<string, any> = {
     AWSTemplateFormatVersion: "2010-09-09",
     Description: "Durable Function examples written in TypeScript.",
     Transform: ["AWS::Serverless-2016-10-31"],
@@ -213,7 +153,7 @@ function generateTemplate(skipVerboseLogging = false) {
   };
 
   // Generate resources for each example file
-  examplesCatalog.forEach((catalog) => {
+  examplesCatalog.forEach((catalog: { name: string; handler: string }) => {
     const resourceName = catalog.name.replace(/\s/g, "") + `-22x-NodeJS-Local`;
     template.Resources[
       toPascalCase(catalog.handler.slice(0, -".handler".length))
@@ -262,7 +202,7 @@ function main() {
     if (skipVerboseLogging) {
       console.log("🔇 Verbose logging disabled");
     }
-  } catch (error) {
+  } catch (error: any) {
     console.error("❌ Error generating template.yml:", error.message);
     process.exit(1);
   }
@@ -273,9 +213,9 @@ if (require.main === module) {
   main();
 }
 
-module.exports = {
+export {
   generateTemplate,
-  getExampleFiles,
   toPascalCase,
   createFunctionResource,
+  getExamplesCatalogJson,
 };