@eventcatalog/generator-amazon-apigateway 1.0.0

package/README.md

@@ -0,0 +1,135 @@
+<div align="center">
+
+<h1>⚡️ Amazon API Gateway generator for EventCatalog</h1>
+
+[![PRs Welcome][prs-badge]][prs]
+<img src="https://img.shields.io/github/actions/workflow/status/event-catalog/generator-asyncapi/verify-build.yml"/>
+[![](https://dcbadge.limes.pink/api/server/https://discord.gg/3rjaZMmrAm?style=flat)](https://discord.gg/3rjaZMmrAm) [<img src="https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white" height="20px" />](https://www.linkedin.com/in/david-boyne/) [![blog](https://img.shields.io/badge/blog-EDA--Visuals-brightgreen)](https://eda-visuals.boyney.io/?utm_source=event-catalog-gihub) [![blog](https://img.shields.io/badge/license-Dual--License-brightgreen)](https://github.com/event-catalog/generator-asyncapi/blob/main/LICENSE.md)
+
+<img alt="header" src="https://github.com/event-catalog/generators/blob/main/images/amazon-apigateway.png?raw=true" />
+
+<h4>Features: Generate EventCatalogs with your Amazon API Gateway OpenAPI files, Map routes to commands, queries and events, Auto versioning of your domains, services and messages, Add Semantic meanings to your APIS</h4>
+
+[Read the Docs](https://eventcatalog.dev/) | [Edit the Docs](https://github.com/event-catalog/docs) | [View Demo](https://demo.eventcatalog.dev/docs)
+
+</div>
+
+<hr/>
+
+# Core Features
+
+- 📃 Document domains, services and messages from your APIs
+- 📊 Visualise your architecture ([demo](https://demo.eventcatalog.dev/visualiser))
+- View your OpenAPI files in EventCatalog and download schemas
+- 💅 Custom MDX components ([read more](https://eventcatalog.dev/docs/development/components/using-components))
+- 🗄️ Auto versioning of your domains, services and messages
+- ⭐ Map routes to commands, queries and events in EventCatalog
+- ⭐ Discoverability feature (search, filter and more) ([demo](https://demo.eventcatalog.dev/discover/events))
+- ⭐ And much more...
+
+# How it works
+
+[EventCatalog](https://www.eventcatalog.dev/) is technology agnostic, meaning it can integrate with any schemas, specs or brokers.
+
+The generator requires the [OpenAPI Generator](https://github.com/event-catalog/generators/tree/main/packages/generator-openapi).
+
+1. Install the Amazon API Gateway Generator
+2. Configure your generator in your `eventcatalog.config.js` file.
+3. This will turn your API Gateway OpenAPI speciifcation files into EventCatalog ready files.
+4. Install the OpenAPI Generator
+5. Configure the OpenAPI generator to read and process files from your output of Amazon API Gateway Generator.
+6. View your APIs, messages, services and domains in EventCatalog.
+
+### Example
+
+This example:
+
+1. Downloads the `Store API` from Amazon API Gateway
+1. Hydrates the OpenAPI file with EventCatalog extensions
+1. Outputs the generated OpenAPI files to `amazon-apigateway-specs`
+
+1. Runs the OpenAPI generator
+1. Processes the generated OpenAPI files into EventCatalog
+
+```js
+...
+generators: [
+    [
+      '@eventcatalogtest/generator-amazon-apigateway',
+      {
+        output: 'amazon-apigateway-specs',
+        apis: [
+          {
+            name: 'Store API',
+            region: 'us-east-1',
+            stageName: 'prod',
+            routes: {
+              'post /users': {
+                type: 'command',
+              }
+            }
+          }
+        ]
+      },
+    ],
+    [
+      '@eventcatalogtest/generator-openapi',
+      {
+        services: [
+          { path: [path.join(__dirname, 'amazon-apigateway-specs', 'Store API.json'), id: 'store' },
+        ],
+        domain: { id: 'Shopping Cart', name: 'Shopping Cart', version: '0.0.1' },
+      },
+    ],
+  ],
+...
+```
+
+# Getting started
+
+## Installation and configuration
+
+_Make sure you are on the latest version of EventCatalog_.
+
+1. Install the packages
+
+```sh
+@eventcatalog/generator-amazon-apigateway
+@eventcatalog/generator-openapi
+```
+
+2. Configure your `eventcatalog.config.js` file
+
+- First configure the API Gateway Geneartor
+- Then configure the OpenAPI generator
+
+3. Run the generate command
+
+```sh
+npm run generate
+```
+
+4. See your new domains, services and messages, run
+
+```sh
+npm run dev
+```
+
+## Found a problem?
+
+Raise a GitHub issue on this project, or contact us on [our Discord server](https://discord.gg/3rjaZMmrAm).
+
+[license-badge]: https://img.shields.io/github/license/event-catalog/eventcatalog.svg?color=yellow
+[license]: https://github.com/event-catalog/eventcatalog/blob/main/LICENSE
+[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
+[prs]: http://makeapullrequest.com
+[github-watch-badge]: https://img.shields.io/github/watchers/event-catalog/eventcatalog.svg?style=social
+[github-watch]: https://github.com/event-catalog/eventcatalog/watchers
+[github-star-badge]: https://img.shields.io/github/stars/event-catalog/eventcatalog.svg?style=social
+[github-star]: https://github.com/event-catalog/eventcatalog/stargazers
+
+# Commercial Use
+
+This project is governed by a [dual-license](./LICENSE.md). To ensure the sustainability of the project, you can freely make use of this software if your projects are Open Source. Otherwise for proprietary systems you must obtain a [commercial license](./LICENSE-COMMERCIAL.md).
+
+You can purchase a license or get a free trial at https://eventcatalog.cloud or email us at `hello@eventcatalog.dev`.

package/dist/index.d.mts

@@ -0,0 +1,25 @@
+import { AwsCredentialIdentity, AwsCredentialIdentityProvider } from '@smithy/types';
+
+type Route = {
+    type: 'command' | 'query' | 'event';
+    id?: string;
+    name?: string;
+    description?: string;
+};
+type API = {
+    name: string;
+    region: string;
+    stageName: string;
+    version?: number;
+    routes: Record<string, Route>;
+};
+type Props = {
+    debug?: boolean;
+    licenseKey?: string;
+    apis: API[];
+    output?: string;
+    credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;
+};
+declare const _default: (_: any, options: Props) => Promise<void>;
+
+export { type API, type Route, _default as default };

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+import { AwsCredentialIdentity, AwsCredentialIdentityProvider } from '@smithy/types';
+
+type Route = {
+    type: 'command' | 'query' | 'event';
+    id?: string;
+    name?: string;
+    description?: string;
+};
+type API = {
+    name: string;
+    region: string;
+    stageName: string;
+    version?: number;
+    routes: Record<string, Route>;
+};
+type Props = {
+    debug?: boolean;
+    licenseKey?: string;
+    apis: API[];
+    output?: string;
+    credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;
+};
+declare const _default: (_: any, options: Props) => Promise<void>;
+
+export { type API, type Route, _default as default };

package/dist/index.js

@@ -0,0 +1,156 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var import_client_api_gateway2 = require("@aws-sdk/client-api-gateway");
+
+// src/utils/apigateway.ts
+var import_client_api_gateway = require("@aws-sdk/client-api-gateway");
+async function getOpenApiSpec(client, restApiId, stageName) {
+  try {
+    const command = new import_client_api_gateway.GetExportCommand({
+      restApiId,
+      stageName,
+      exportType: "oas30",
+      // Use 'swagger' for Swagger/OpenAPI 2.0
+      accepts: "application/json"
+    });
+    const response = await client.send(command);
+    let openAPISpec;
+    try {
+      openAPISpec = new TextDecoder().decode(response.body);
+      return JSON.parse(openAPISpec);
+    } catch (error) {
+      return response.body;
+    }
+  } catch (error) {
+    console.error("Error fetching OpenAPI specification:", error);
+    throw error;
+  }
+}
+async function getRestApiIdByName(client, apiName) {
+  try {
+    let position;
+    do {
+      const command = new import_client_api_gateway.GetRestApisCommand({
+        position
+        // Include the position token for pagination
+      });
+      const response = await client.send(command);
+      const api = response.items?.find((api2) => api2.name === apiName);
+      if (api) {
+        return api.id;
+      }
+      position = response.position;
+    } while (position);
+    throw new Error(`API with name '${apiName}' not found`);
+  } catch (error) {
+    console.error("Error fetching REST API ID:", error);
+    throw error;
+  }
+}
+
+// src/utils/hydrate-openapi-file.ts
+async function hydrate(openApiSpec, routeConfig, version) {
+  const modifiedSpec = JSON.parse(JSON.stringify(openApiSpec));
+  const defaultMessageType = "query";
+  const specVersion = version || routeConfig.version || 1;
+  modifiedSpec.info.version = `${specVersion}`;
+  for (const [path, pathItem] of Object.entries(modifiedSpec.paths)) {
+    for (const [method, operation] of Object.entries(pathItem)) {
+      if (operation && typeof operation === "object" && !Array.isArray(operation)) {
+        const operationObj = operation;
+        const configKey = `${method.toLowerCase()} ${path}`;
+        const config = routeConfig[configKey] || {};
+        const messageType = typeof config === "string" ? config : config.type || defaultMessageType;
+        operationObj["x-eventcatalog-message-type"] = messageType;
+        if (typeof config === "object" && config.id) {
+          operationObj.operationId = config.id;
+        } else if (!operationObj.operationId) {
+          const normalizedPath = path.replace(/^\//, "").replace(/\//g, "_").replace(/[{}]/g, "");
+          operationObj.operationId = `${method.toLowerCase()}_${normalizedPath}`;
+        }
+        if (typeof config === "object" && config.description) {
+          operationObj.description = config.description;
+        }
+        if (typeof config === "object") {
+          if (config.id) {
+            operationObj["x-eventcatalog-message-id"] = config.id;
+          }
+          if (config.name) {
+            operationObj["x-eventcatalog-message-name"] = config.name;
+          }
+        }
+      }
+    }
+  }
+  return modifiedSpec;
+}
+
+// src/index.ts
+var import_promises = require("fs/promises");
+var import_node_path = require("path");
+var import_chalk = __toESM(require("chalk"));
+var import_promises2 = __toESM(require("fs/promises"));
+var index_default = async (_, options) => {
+  if (!process.env.PROJECT_DIR) {
+    process.env.PROJECT_DIR = process.cwd();
+  }
+  if (!process.env.PROJECT_DIR) {
+    throw new Error("Please provide catalog url (env variable PROJECT_DIR)");
+  }
+  const outputDir = options.output ? (0, import_node_path.join)(process.env.PROJECT_DIR, options.output) : (0, import_node_path.join)(process.env.PROJECT_DIR, "amazon-apigateway-specs");
+  console.log(import_chalk.default.green(`Processing ${options.apis.length} apis with API Gateway`));
+  for (const api of options.apis) {
+    console.log(import_chalk.default.gray(`Processing ${api.name} in ${api.region} with Amazon API Gateway...`));
+    const client = new import_client_api_gateway2.APIGatewayClient({ region: api.region, credentials: options.credentials });
+    const apiName = await getRestApiIdByName(client, api.name);
+    if (!apiName) {
+      console.log(import_chalk.default.yellow(` - API with name '${api.name}' not found, skipping import...`));
+      continue;
+    }
+    const openApiSpec = await getOpenApiSpec(client, apiName, api.stageName);
+    console.log(import_chalk.default.cyan(` - Found OpenAPI file, hydrating with EventCatalog extensions...`));
+    const hydratedSpec = await hydrate(openApiSpec, api.routes, api.version);
+    const output = (0, import_node_path.join)(process.env.PROJECT_DIR, "amazon-apigateway-specs", `${api.name}.json`);
+    await import_promises2.default.mkdir(outputDir, { recursive: true });
+    console.log(import_chalk.default.cyan(` - Writing OpenAPI file to ${output}...`));
+    await (0, import_promises.writeFile)(output, JSON.stringify(hydratedSpec, null, 2));
+  }
+  console.log(import_chalk.default.green(`
+Finished generating event catalog with Amazon API Gateway Apis.`));
+  console.log(import_chalk.default.green(`
+Specifications have been written to ${outputDir}`));
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/utils/apigateway.ts","../src/utils/hydrate-openapi-file.ts"],"sourcesContent":["import { APIGatewayClient } from '@aws-sdk/client-api-gateway';\nimport { AwsCredentialIdentity, AwsCredentialIdentityProvider } from '@smithy/types';\nimport { getOpenApiSpec, getRestApiIdByName } from './utils/apigateway';\nimport { hydrate } from './utils/hydrate-openapi-file';\nimport { writeFile } from 'node:fs/promises';\nimport { join } from 'node:path';\nimport chalk from 'chalk';\nimport fs from 'fs/promises';\n\nexport type Route = {\n  type: 'command' | 'query' | 'event';\n  id?: string;\n  name?: string;\n  description?: string;\n};\n\nexport type API = {\n  name: string;\n  region: string;\n  stageName: string;\n  version?: number;\n  routes: Record<string, Route>;\n};\n\ntype Props = {\n  debug?: boolean;\n  licenseKey?: string;\n  apis: API[];\n  output?: string;\n  credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;\n};\n\nexport default async (_: any, options: Props) => {\n  if (!process.env.PROJECT_DIR) {\n    process.env.PROJECT_DIR = process.cwd();\n  }\n\n  if (!process.env.PROJECT_DIR) {\n    throw new Error('Please provide catalog url (env variable PROJECT_DIR)');\n  }\n\n  const outputDir = options.output\n    ? join(process.env.PROJECT_DIR, options.output)\n    : join(process.env.PROJECT_DIR, 'amazon-apigateway-specs');\n\n  console.log(chalk.green(`Processing ${options.apis.length} apis with API Gateway`));\n\n  // Loop through all the APIS and hydrate the openapi spec\n  for (const api of options.apis) {\n    console.log(chalk.gray(`Processing ${api.name} in ${api.region} with Amazon API Gateway...`));\n\n    const client = new APIGatewayClient({ region: api.region, credentials: options.credentials });\n\n    const apiName = await getRestApiIdByName(client, api.name);\n\n    if (!apiName) {\n      console.log(chalk.yellow(` - API with name '${api.name}' not found, skipping import...`));\n      continue;\n    }\n\n    const openApiSpec = await getOpenApiSpec(client, apiName, api.stageName);\n\n    console.log(chalk.cyan(` - Found OpenAPI file, hydrating with EventCatalog extensions...`));\n    const hydratedSpec = await hydrate(openApiSpec, api.routes, api.version);\n\n    const output = join(process.env.PROJECT_DIR, 'amazon-apigateway-specs', `${api.name}.json`);\n\n    // ensure the directory exists\n    await fs.mkdir(outputDir, { recursive: true });\n\n    console.log(chalk.cyan(` - Writing OpenAPI file to ${output}...`));\n    await writeFile(output, JSON.stringify(hydratedSpec, null, 2));\n  }\n\n  console.log(chalk.green(`\\nFinished generating event catalog with Amazon API Gateway Apis.`));\n  console.log(chalk.green(`\\nSpecifications have been written to ${outputDir}`));\n};\n","import { APIGatewayClient, GetExportCommand, GetRestApisCommand } from '@aws-sdk/client-api-gateway';\n\nexport async function getOpenApiSpec(client: APIGatewayClient, restApiId: string, stageName: string) {\n  try {\n    const command = new GetExportCommand({\n      restApiId: restApiId,\n      stageName: stageName,\n      exportType: 'oas30', // Use 'swagger' for Swagger/OpenAPI 2.0\n      accepts: 'application/json',\n    });\n\n    const response = await client.send(command);\n\n    let openAPISpec;\n\n    try {\n      openAPISpec = new TextDecoder().decode(response.body);\n      return JSON.parse(openAPISpec);\n    } catch (error) {\n      return response.body;\n    }\n  } catch (error) {\n    console.error('Error fetching OpenAPI specification:', error);\n    throw error;\n  }\n}\n\nexport async function getRestApiIdByName(client: APIGatewayClient, apiName: string) {\n  try {\n    let position: string | undefined;\n    do {\n      const command = new GetRestApisCommand({\n        position: position, // Include the position token for pagination\n      });\n      const response = await client.send(command);\n\n      const api = response.items?.find((api) => api.name === apiName);\n      if (api) {\n        return api.id; // Found the API, return its ID\n      }\n\n      position = response.position; // Get the next position token\n    } while (position); // Continue while there are more APIs to fetch\n\n    throw new Error(`API with name '${apiName}' not found`);\n  } catch (error) {\n    console.error('Error fetching REST API ID:', error);\n    throw error;\n  }\n}\n","export async function hydrate(openApiSpec: any, routeConfig: any, version?: number) {\n  // Clone the spec to avoid modifying the original\n  const modifiedSpec = JSON.parse(JSON.stringify(openApiSpec));\n\n  // Default configuration - all routes are queries unless specified\n  const defaultMessageType = 'query';\n\n  // Set version from config or default to 1\n  const specVersion = version || routeConfig.version || 1;\n  modifiedSpec.info.version = `${specVersion}`;\n\n  // Iterate through all paths and their methods\n  for (const [path, pathItem] of Object.entries(modifiedSpec.paths)) {\n    for (const [method, operation] of Object.entries(pathItem as Record<string, unknown>)) {\n      if (operation && typeof operation === 'object' && !Array.isArray(operation)) {\n        const operationObj = operation as {\n          operationId?: string;\n          description?: string;\n          [key: string]: any;\n        };\n\n        const configKey = `${method.toLowerCase()} ${path}`;\n        const config = routeConfig[configKey] || {};\n\n        // Add message type extension\n        const messageType = typeof config === 'string' ? config : config.type || defaultMessageType;\n        operationObj['x-eventcatalog-message-type'] = messageType;\n\n        // Set operationId\n        if (typeof config === 'object' && config.id) {\n          operationObj.operationId = config.id;\n        } else if (!operationObj.operationId) {\n          const normalizedPath = path.replace(/^\\//, '').replace(/\\//g, '_').replace(/[{}]/g, '');\n\n          operationObj.operationId = `${method.toLowerCase()}_${normalizedPath}`;\n        }\n\n        // Add description if provided in config\n        if (typeof config === 'object' && config.description) {\n          operationObj.description = config.description;\n        }\n\n        // Add optional message ID and name if provided\n        if (typeof config === 'object') {\n          if (config.id) {\n            operationObj['x-eventcatalog-message-id'] = config.id;\n          }\n          if (config.name) {\n            operationObj['x-eventcatalog-message-name'] = config.name;\n          }\n        }\n      }\n    }\n  }\n\n  return modifiedSpec;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAAAA,6BAAiC;;;ACAjC,gCAAuE;AAEvE,eAAsB,eAAe,QAA0B,WAAmB,WAAmB;AACnG,MAAI;AACF,UAAM,UAAU,IAAI,2CAAiB;AAAA,MACnC;AAAA,MACA;AAAA,MACA,YAAY;AAAA;AAAA,MACZ,SAAS;AAAA,IACX,CAAC;AAED,UAAM,WAAW,MAAM,OAAO,KAAK,OAAO;AAE1C,QAAI;AAEJ,QAAI;AACF,oBAAc,IAAI,YAAY,EAAE,OAAO,SAAS,IAAI;AACpD,aAAO,KAAK,MAAM,WAAW;AAAA,IAC/B,SAAS,OAAO;AACd,aAAO,SAAS;AAAA,IAClB;AAAA,EACF,SAAS,OAAO;AACd,YAAQ,MAAM,yCAAyC,KAAK;AAC5D,UAAM;AAAA,EACR;AACF;AAEA,eAAsB,mBAAmB,QAA0B,SAAiB;AAClF,MAAI;AACF,QAAI;AACJ,OAAG;AACD,YAAM,UAAU,IAAI,6CAAmB;AAAA,QACrC;AAAA;AAAA,MACF,CAAC;AACD,YAAM,WAAW,MAAM,OAAO,KAAK,OAAO;AAE1C,YAAM,MAAM,SAAS,OAAO,KAAK,CAACC,SAAQA,KAAI,SAAS,OAAO;AAC9D,UAAI,KAAK;AACP,eAAO,IAAI;AAAA,MACb;AAEA,iBAAW,SAAS;AAAA,IACtB,SAAS;AAET,UAAM,IAAI,MAAM,kBAAkB,OAAO,aAAa;AAAA,EACxD,SAAS,OAAO;AACd,YAAQ,MAAM,+BAA+B,KAAK;AAClD,UAAM;AAAA,EACR;AACF;;;ACjDA,eAAsB,QAAQ,aAAkB,aAAkB,SAAkB;AAElF,QAAM,eAAe,KAAK,MAAM,KAAK,UAAU,WAAW,CAAC;AAG3D,QAAM,qBAAqB;AAG3B,QAAM,cAAc,WAAW,YAAY,WAAW;AACtD,eAAa,KAAK,UAAU,GAAG,WAAW;AAG1C,aAAW,CAAC,MAAM,QAAQ,KAAK,OAAO,QAAQ,aAAa,KAAK,GAAG;AACjE,eAAW,CAAC,QAAQ,SAAS,KAAK,OAAO,QAAQ,QAAmC,GAAG;AACrF,UAAI,aAAa,OAAO,cAAc,YAAY,CAAC,MAAM,QAAQ,SAAS,GAAG;AAC3E,cAAM,eAAe;AAMrB,cAAM,YAAY,GAAG,OAAO,YAAY,CAAC,IAAI,IAAI;AACjD,cAAM,SAAS,YAAY,SAAS,KAAK,CAAC;AAG1C,cAAM,cAAc,OAAO,WAAW,WAAW,SAAS,OAAO,QAAQ;AACzE,qBAAa,6BAA6B,IAAI;AAG9C,YAAI,OAAO,WAAW,YAAY,OAAO,IAAI;AAC3C,uBAAa,cAAc,OAAO;AAAA,QACpC,WAAW,CAAC,aAAa,aAAa;AACpC,gBAAM,iBAAiB,KAAK,QAAQ,OAAO,EAAE,EAAE,QAAQ,OAAO,GAAG,EAAE,QAAQ,SAAS,EAAE;AAEtF,uBAAa,cAAc,GAAG,OAAO,YAAY,CAAC,IAAI,cAAc;AAAA,QACtE;AAGA,YAAI,OAAO,WAAW,YAAY,OAAO,aAAa;AACpD,uBAAa,cAAc,OAAO;AAAA,QACpC;AAGA,YAAI,OAAO,WAAW,UAAU;AAC9B,cAAI,OAAO,IAAI;AACb,yBAAa,2BAA2B,IAAI,OAAO;AAAA,UACrD;AACA,cAAI,OAAO,MAAM;AACf,yBAAa,6BAA6B,IAAI,OAAO;AAAA,UACvD;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;;;AFpDA,sBAA0B;AAC1B,uBAAqB;AACrB,mBAAkB;AAClB,IAAAC,mBAAe;AAyBf,IAAO,gBAAQ,OAAO,GAAQ,YAAmB;AAC/C,MAAI,CAAC,QAAQ,IAAI,aAAa;AAC5B,YAAQ,IAAI,cAAc,QAAQ,IAAI;AAAA,EACxC;AAEA,MAAI,CAAC,QAAQ,IAAI,aAAa;AAC5B,UAAM,IAAI,MAAM,uDAAuD;AAAA,EACzE;AAEA,QAAM,YAAY,QAAQ,aACtB,uBAAK,QAAQ,IAAI,aAAa,QAAQ,MAAM,QAC5C,uBAAK,QAAQ,IAAI,aAAa,yBAAyB;AAE3D,UAAQ,IAAI,aAAAC,QAAM,MAAM,cAAc,QAAQ,KAAK,MAAM,wBAAwB,CAAC;AAGlF,aAAW,OAAO,QAAQ,MAAM;AAC9B,YAAQ,IAAI,aAAAA,QAAM,KAAK,cAAc,IAAI,IAAI,OAAO,IAAI,MAAM,6BAA6B,CAAC;AAE5F,UAAM,SAAS,IAAI,4CAAiB,EAAE,QAAQ,IAAI,QAAQ,aAAa,QAAQ,YAAY,CAAC;AAE5F,UAAM,UAAU,MAAM,mBAAmB,QAAQ,IAAI,IAAI;AAEzD,QAAI,CAAC,SAAS;AACZ,cAAQ,IAAI,aAAAA,QAAM,OAAO,qBAAqB,IAAI,IAAI,iCAAiC,CAAC;AACxF;AAAA,IACF;AAEA,UAAM,cAAc,MAAM,eAAe,QAAQ,SAAS,IAAI,SAAS;AAEvE,YAAQ,IAAI,aAAAA,QAAM,KAAK,kEAAkE,CAAC;AAC1F,UAAM,eAAe,MAAM,QAAQ,aAAa,IAAI,QAAQ,IAAI,OAAO;AAEvE,UAAM,aAAS,uBAAK,QAAQ,IAAI,aAAa,2BAA2B,GAAG,IAAI,IAAI,OAAO;AAG1F,UAAM,iBAAAC,QAAG,MAAM,WAAW,EAAE,WAAW,KAAK,CAAC;AAE7C,YAAQ,IAAI,aAAAD,QAAM,KAAK,8BAA8B,MAAM,KAAK,CAAC;AACjE,cAAM,2BAAU,QAAQ,KAAK,UAAU,cAAc,MAAM,CAAC,CAAC;AAAA,EAC/D;AAEA,UAAQ,IAAI,aAAAA,QAAM,MAAM;AAAA,gEAAmE,CAAC;AAC5F,UAAQ,IAAI,aAAAA,QAAM,MAAM;AAAA,sCAAyC,SAAS,EAAE,CAAC;AAC/E;","names":["import_client_api_gateway","api","import_promises","chalk","fs"]}

package/dist/index.mjs

@@ -0,0 +1,125 @@
+// src/index.ts
+import { APIGatewayClient as APIGatewayClient2 } from "@aws-sdk/client-api-gateway";
+
+// src/utils/apigateway.ts
+import { GetExportCommand, GetRestApisCommand } from "@aws-sdk/client-api-gateway";
+async function getOpenApiSpec(client, restApiId, stageName) {
+  try {
+    const command = new GetExportCommand({
+      restApiId,
+      stageName,
+      exportType: "oas30",
+      // Use 'swagger' for Swagger/OpenAPI 2.0
+      accepts: "application/json"
+    });
+    const response = await client.send(command);
+    let openAPISpec;
+    try {
+      openAPISpec = new TextDecoder().decode(response.body);
+      return JSON.parse(openAPISpec);
+    } catch (error) {
+      return response.body;
+    }
+  } catch (error) {
+    console.error("Error fetching OpenAPI specification:", error);
+    throw error;
+  }
+}
+async function getRestApiIdByName(client, apiName) {
+  try {
+    let position;
+    do {
+      const command = new GetRestApisCommand({
+        position
+        // Include the position token for pagination
+      });
+      const response = await client.send(command);
+      const api = response.items?.find((api2) => api2.name === apiName);
+      if (api) {
+        return api.id;
+      }
+      position = response.position;
+    } while (position);
+    throw new Error(`API with name '${apiName}' not found`);
+  } catch (error) {
+    console.error("Error fetching REST API ID:", error);
+    throw error;
+  }
+}
+
+// src/utils/hydrate-openapi-file.ts
+async function hydrate(openApiSpec, routeConfig, version) {
+  const modifiedSpec = JSON.parse(JSON.stringify(openApiSpec));
+  const defaultMessageType = "query";
+  const specVersion = version || routeConfig.version || 1;
+  modifiedSpec.info.version = `${specVersion}`;
+  for (const [path, pathItem] of Object.entries(modifiedSpec.paths)) {
+    for (const [method, operation] of Object.entries(pathItem)) {
+      if (operation && typeof operation === "object" && !Array.isArray(operation)) {
+        const operationObj = operation;
+        const configKey = `${method.toLowerCase()} ${path}`;
+        const config = routeConfig[configKey] || {};
+        const messageType = typeof config === "string" ? config : config.type || defaultMessageType;
+        operationObj["x-eventcatalog-message-type"] = messageType;
+        if (typeof config === "object" && config.id) {
+          operationObj.operationId = config.id;
+        } else if (!operationObj.operationId) {
+          const normalizedPath = path.replace(/^\//, "").replace(/\//g, "_").replace(/[{}]/g, "");
+          operationObj.operationId = `${method.toLowerCase()}_${normalizedPath}`;
+        }
+        if (typeof config === "object" && config.description) {
+          operationObj.description = config.description;
+        }
+        if (typeof config === "object") {
+          if (config.id) {
+            operationObj["x-eventcatalog-message-id"] = config.id;
+          }
+          if (config.name) {
+            operationObj["x-eventcatalog-message-name"] = config.name;
+          }
+        }
+      }
+    }
+  }
+  return modifiedSpec;
+}
+
+// src/index.ts
+import { writeFile } from "node:fs/promises";
+import { join } from "node:path";
+import chalk from "chalk";
+import fs from "fs/promises";
+var index_default = async (_, options) => {
+  if (!process.env.PROJECT_DIR) {
+    process.env.PROJECT_DIR = process.cwd();
+  }
+  if (!process.env.PROJECT_DIR) {
+    throw new Error("Please provide catalog url (env variable PROJECT_DIR)");
+  }
+  const outputDir = options.output ? join(process.env.PROJECT_DIR, options.output) : join(process.env.PROJECT_DIR, "amazon-apigateway-specs");
+  console.log(chalk.green(`Processing ${options.apis.length} apis with API Gateway`));
+  for (const api of options.apis) {
+    console.log(chalk.gray(`Processing ${api.name} in ${api.region} with Amazon API Gateway...`));
+    const client = new APIGatewayClient2({ region: api.region, credentials: options.credentials });
+    const apiName = await getRestApiIdByName(client, api.name);
+    if (!apiName) {
+      console.log(chalk.yellow(` - API with name '${api.name}' not found, skipping import...`));
+      continue;
+    }
+    const openApiSpec = await getOpenApiSpec(client, apiName, api.stageName);
+    console.log(chalk.cyan(` - Found OpenAPI file, hydrating with EventCatalog extensions...`));
+    const hydratedSpec = await hydrate(openApiSpec, api.routes, api.version);
+    const output = join(process.env.PROJECT_DIR, "amazon-apigateway-specs", `${api.name}.json`);
+    await fs.mkdir(outputDir, { recursive: true });
+    console.log(chalk.cyan(` - Writing OpenAPI file to ${output}...`));
+    await writeFile(output, JSON.stringify(hydratedSpec, null, 2));
+  }
+  console.log(chalk.green(`
+Finished generating event catalog with Amazon API Gateway Apis.`));
+  console.log(chalk.green(`
+Specifications have been written to ${outputDir}`));
+};
+export {
+  index_default as default
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/utils/apigateway.ts","../src/utils/hydrate-openapi-file.ts"],"sourcesContent":["import { APIGatewayClient } from '@aws-sdk/client-api-gateway';\nimport { AwsCredentialIdentity, AwsCredentialIdentityProvider } from '@smithy/types';\nimport { getOpenApiSpec, getRestApiIdByName } from './utils/apigateway';\nimport { hydrate } from './utils/hydrate-openapi-file';\nimport { writeFile } from 'node:fs/promises';\nimport { join } from 'node:path';\nimport chalk from 'chalk';\nimport fs from 'fs/promises';\n\nexport type Route = {\n  type: 'command' | 'query' | 'event';\n  id?: string;\n  name?: string;\n  description?: string;\n};\n\nexport type API = {\n  name: string;\n  region: string;\n  stageName: string;\n  version?: number;\n  routes: Record<string, Route>;\n};\n\ntype Props = {\n  debug?: boolean;\n  licenseKey?: string;\n  apis: API[];\n  output?: string;\n  credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;\n};\n\nexport default async (_: any, options: Props) => {\n  if (!process.env.PROJECT_DIR) {\n    process.env.PROJECT_DIR = process.cwd();\n  }\n\n  if (!process.env.PROJECT_DIR) {\n    throw new Error('Please provide catalog url (env variable PROJECT_DIR)');\n  }\n\n  const outputDir = options.output\n    ? join(process.env.PROJECT_DIR, options.output)\n    : join(process.env.PROJECT_DIR, 'amazon-apigateway-specs');\n\n  console.log(chalk.green(`Processing ${options.apis.length} apis with API Gateway`));\n\n  // Loop through all the APIS and hydrate the openapi spec\n  for (const api of options.apis) {\n    console.log(chalk.gray(`Processing ${api.name} in ${api.region} with Amazon API Gateway...`));\n\n    const client = new APIGatewayClient({ region: api.region, credentials: options.credentials });\n\n    const apiName = await getRestApiIdByName(client, api.name);\n\n    if (!apiName) {\n      console.log(chalk.yellow(` - API with name '${api.name}' not found, skipping import...`));\n      continue;\n    }\n\n    const openApiSpec = await getOpenApiSpec(client, apiName, api.stageName);\n\n    console.log(chalk.cyan(` - Found OpenAPI file, hydrating with EventCatalog extensions...`));\n    const hydratedSpec = await hydrate(openApiSpec, api.routes, api.version);\n\n    const output = join(process.env.PROJECT_DIR, 'amazon-apigateway-specs', `${api.name}.json`);\n\n    // ensure the directory exists\n    await fs.mkdir(outputDir, { recursive: true });\n\n    console.log(chalk.cyan(` - Writing OpenAPI file to ${output}...`));\n    await writeFile(output, JSON.stringify(hydratedSpec, null, 2));\n  }\n\n  console.log(chalk.green(`\\nFinished generating event catalog with Amazon API Gateway Apis.`));\n  console.log(chalk.green(`\\nSpecifications have been written to ${outputDir}`));\n};\n","import { APIGatewayClient, GetExportCommand, GetRestApisCommand } from '@aws-sdk/client-api-gateway';\n\nexport async function getOpenApiSpec(client: APIGatewayClient, restApiId: string, stageName: string) {\n  try {\n    const command = new GetExportCommand({\n      restApiId: restApiId,\n      stageName: stageName,\n      exportType: 'oas30', // Use 'swagger' for Swagger/OpenAPI 2.0\n      accepts: 'application/json',\n    });\n\n    const response = await client.send(command);\n\n    let openAPISpec;\n\n    try {\n      openAPISpec = new TextDecoder().decode(response.body);\n      return JSON.parse(openAPISpec);\n    } catch (error) {\n      return response.body;\n    }\n  } catch (error) {\n    console.error('Error fetching OpenAPI specification:', error);\n    throw error;\n  }\n}\n\nexport async function getRestApiIdByName(client: APIGatewayClient, apiName: string) {\n  try {\n    let position: string | undefined;\n    do {\n      const command = new GetRestApisCommand({\n        position: position, // Include the position token for pagination\n      });\n      const response = await client.send(command);\n\n      const api = response.items?.find((api) => api.name === apiName);\n      if (api) {\n        return api.id; // Found the API, return its ID\n      }\n\n      position = response.position; // Get the next position token\n    } while (position); // Continue while there are more APIs to fetch\n\n    throw new Error(`API with name '${apiName}' not found`);\n  } catch (error) {\n    console.error('Error fetching REST API ID:', error);\n    throw error;\n  }\n}\n","export async function hydrate(openApiSpec: any, routeConfig: any, version?: number) {\n  // Clone the spec to avoid modifying the original\n  const modifiedSpec = JSON.parse(JSON.stringify(openApiSpec));\n\n  // Default configuration - all routes are queries unless specified\n  const defaultMessageType = 'query';\n\n  // Set version from config or default to 1\n  const specVersion = version || routeConfig.version || 1;\n  modifiedSpec.info.version = `${specVersion}`;\n\n  // Iterate through all paths and their methods\n  for (const [path, pathItem] of Object.entries(modifiedSpec.paths)) {\n    for (const [method, operation] of Object.entries(pathItem as Record<string, unknown>)) {\n      if (operation && typeof operation === 'object' && !Array.isArray(operation)) {\n        const operationObj = operation as {\n          operationId?: string;\n          description?: string;\n          [key: string]: any;\n        };\n\n        const configKey = `${method.toLowerCase()} ${path}`;\n        const config = routeConfig[configKey] || {};\n\n        // Add message type extension\n        const messageType = typeof config === 'string' ? config : config.type || defaultMessageType;\n        operationObj['x-eventcatalog-message-type'] = messageType;\n\n        // Set operationId\n        if (typeof config === 'object' && config.id) {\n          operationObj.operationId = config.id;\n        } else if (!operationObj.operationId) {\n          const normalizedPath = path.replace(/^\\//, '').replace(/\\//g, '_').replace(/[{}]/g, '');\n\n          operationObj.operationId = `${method.toLowerCase()}_${normalizedPath}`;\n        }\n\n        // Add description if provided in config\n        if (typeof config === 'object' && config.description) {\n          operationObj.description = config.description;\n        }\n\n        // Add optional message ID and name if provided\n        if (typeof config === 'object') {\n          if (config.id) {\n            operationObj['x-eventcatalog-message-id'] = config.id;\n          }\n          if (config.name) {\n            operationObj['x-eventcatalog-message-name'] = config.name;\n          }\n        }\n      }\n    }\n  }\n\n  return modifiedSpec;\n}\n"],"mappings":";AAAA,SAAS,oBAAAA,yBAAwB;;;ACAjC,SAA2B,kBAAkB,0BAA0B;AAEvE,eAAsB,eAAe,QAA0B,WAAmB,WAAmB;AACnG,MAAI;AACF,UAAM,UAAU,IAAI,iBAAiB;AAAA,MACnC;AAAA,MACA;AAAA,MACA,YAAY;AAAA;AAAA,MACZ,SAAS;AAAA,IACX,CAAC;AAED,UAAM,WAAW,MAAM,OAAO,KAAK,OAAO;AAE1C,QAAI;AAEJ,QAAI;AACF,oBAAc,IAAI,YAAY,EAAE,OAAO,SAAS,IAAI;AACpD,aAAO,KAAK,MAAM,WAAW;AAAA,IAC/B,SAAS,OAAO;AACd,aAAO,SAAS;AAAA,IAClB;AAAA,EACF,SAAS,OAAO;AACd,YAAQ,MAAM,yCAAyC,KAAK;AAC5D,UAAM;AAAA,EACR;AACF;AAEA,eAAsB,mBAAmB,QAA0B,SAAiB;AAClF,MAAI;AACF,QAAI;AACJ,OAAG;AACD,YAAM,UAAU,IAAI,mBAAmB;AAAA,QACrC;AAAA;AAAA,MACF,CAAC;AACD,YAAM,WAAW,MAAM,OAAO,KAAK,OAAO;AAE1C,YAAM,MAAM,SAAS,OAAO,KAAK,CAACC,SAAQA,KAAI,SAAS,OAAO;AAC9D,UAAI,KAAK;AACP,eAAO,IAAI;AAAA,MACb;AAEA,iBAAW,SAAS;AAAA,IACtB,SAAS;AAET,UAAM,IAAI,MAAM,kBAAkB,OAAO,aAAa;AAAA,EACxD,SAAS,OAAO;AACd,YAAQ,MAAM,+BAA+B,KAAK;AAClD,UAAM;AAAA,EACR;AACF;;;ACjDA,eAAsB,QAAQ,aAAkB,aAAkB,SAAkB;AAElF,QAAM,eAAe,KAAK,MAAM,KAAK,UAAU,WAAW,CAAC;AAG3D,QAAM,qBAAqB;AAG3B,QAAM,cAAc,WAAW,YAAY,WAAW;AACtD,eAAa,KAAK,UAAU,GAAG,WAAW;AAG1C,aAAW,CAAC,MAAM,QAAQ,KAAK,OAAO,QAAQ,aAAa,KAAK,GAAG;AACjE,eAAW,CAAC,QAAQ,SAAS,KAAK,OAAO,QAAQ,QAAmC,GAAG;AACrF,UAAI,aAAa,OAAO,cAAc,YAAY,CAAC,MAAM,QAAQ,SAAS,GAAG;AAC3E,cAAM,eAAe;AAMrB,cAAM,YAAY,GAAG,OAAO,YAAY,CAAC,IAAI,IAAI;AACjD,cAAM,SAAS,YAAY,SAAS,KAAK,CAAC;AAG1C,cAAM,cAAc,OAAO,WAAW,WAAW,SAAS,OAAO,QAAQ;AACzE,qBAAa,6BAA6B,IAAI;AAG9C,YAAI,OAAO,WAAW,YAAY,OAAO,IAAI;AAC3C,uBAAa,cAAc,OAAO;AAAA,QACpC,WAAW,CAAC,aAAa,aAAa;AACpC,gBAAM,iBAAiB,KAAK,QAAQ,OAAO,EAAE,EAAE,QAAQ,OAAO,GAAG,EAAE,QAAQ,SAAS,EAAE;AAEtF,uBAAa,cAAc,GAAG,OAAO,YAAY,CAAC,IAAI,cAAc;AAAA,QACtE;AAGA,YAAI,OAAO,WAAW,YAAY,OAAO,aAAa;AACpD,uBAAa,cAAc,OAAO;AAAA,QACpC;AAGA,YAAI,OAAO,WAAW,UAAU;AAC9B,cAAI,OAAO,IAAI;AACb,yBAAa,2BAA2B,IAAI,OAAO;AAAA,UACrD;AACA,cAAI,OAAO,MAAM;AACf,yBAAa,6BAA6B,IAAI,OAAO;AAAA,UACvD;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;;;AFpDA,SAAS,iBAAiB;AAC1B,SAAS,YAAY;AACrB,OAAO,WAAW;AAClB,OAAO,QAAQ;AAyBf,IAAO,gBAAQ,OAAO,GAAQ,YAAmB;AAC/C,MAAI,CAAC,QAAQ,IAAI,aAAa;AAC5B,YAAQ,IAAI,cAAc,QAAQ,IAAI;AAAA,EACxC;AAEA,MAAI,CAAC,QAAQ,IAAI,aAAa;AAC5B,UAAM,IAAI,MAAM,uDAAuD;AAAA,EACzE;AAEA,QAAM,YAAY,QAAQ,SACtB,KAAK,QAAQ,IAAI,aAAa,QAAQ,MAAM,IAC5C,KAAK,QAAQ,IAAI,aAAa,yBAAyB;AAE3D,UAAQ,IAAI,MAAM,MAAM,cAAc,QAAQ,KAAK,MAAM,wBAAwB,CAAC;AAGlF,aAAW,OAAO,QAAQ,MAAM;AAC9B,YAAQ,IAAI,MAAM,KAAK,cAAc,IAAI,IAAI,OAAO,IAAI,MAAM,6BAA6B,CAAC;AAE5F,UAAM,SAAS,IAAIC,kBAAiB,EAAE,QAAQ,IAAI,QAAQ,aAAa,QAAQ,YAAY,CAAC;AAE5F,UAAM,UAAU,MAAM,mBAAmB,QAAQ,IAAI,IAAI;AAEzD,QAAI,CAAC,SAAS;AACZ,cAAQ,IAAI,MAAM,OAAO,qBAAqB,IAAI,IAAI,iCAAiC,CAAC;AACxF;AAAA,IACF;AAEA,UAAM,cAAc,MAAM,eAAe,QAAQ,SAAS,IAAI,SAAS;AAEvE,YAAQ,IAAI,MAAM,KAAK,kEAAkE,CAAC;AAC1F,UAAM,eAAe,MAAM,QAAQ,aAAa,IAAI,QAAQ,IAAI,OAAO;AAEvE,UAAM,SAAS,KAAK,QAAQ,IAAI,aAAa,2BAA2B,GAAG,IAAI,IAAI,OAAO;AAG1F,UAAM,GAAG,MAAM,WAAW,EAAE,WAAW,KAAK,CAAC;AAE7C,YAAQ,IAAI,MAAM,KAAK,8BAA8B,MAAM,KAAK,CAAC;AACjE,UAAM,UAAU,QAAQ,KAAK,UAAU,cAAc,MAAM,CAAC,CAAC;AAAA,EAC/D;AAEA,UAAQ,IAAI,MAAM,MAAM;AAAA,gEAAmE,CAAC;AAC5F,UAAQ,IAAI,MAAM,MAAM;AAAA,sCAAyC,SAAS,EAAE,CAAC;AAC/E;","names":["APIGatewayClient","api","APIGatewayClient"]}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@eventcatalog/generator-amazon-apigateway",
+  "version": "1.0.0",
+  "description": "Generator for Amazon API Gateway",
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest",
+    "format": "prettier --write .",
+    "format:diff": "prettier --list-different .",
+    "changeset": "changeset",
+    "release": "changeset publish"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@smithy/types": "^3.5.0",
+    "@types/node": "^20.16.1",
+    "prettier": "^3.3.3",
+    "tsup": "^8.1.0",
+    "typescript": "^5.5.3",
+    "vitest": "^2.0.2"
+  },
+  "files": [
+    "dist",
+    "package.json"
+  ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "dependencies": {
+    "@aws-sdk/client-api-gateway": "^3.743.0",
+    "@aws-sdk/credential-provider-node": "^3.743.0",
+    "@changesets/cli": "^2.27.7",
+    "chalk": "^4"
+  }
+}