@backstage/plugin-events-backend-module-aws-sqs 0.0.0-nightly-20221115024001

package/CHANGELOG.md

@@ -0,0 +1,23 @@
+# @backstage/plugin-events-backend-module-aws-sqs
+
+## 0.0.0-nightly-20221115024001
+
+### Minor Changes
+
+- d3ecb2382d: Adds a new module `aws-sqs` for plugin-events-backend.
+
+  The module provides an event publisher `AwsSqsConsumingEventPublisher`
+  which will allow you to receive events from
+  an AWS SQS queue and will publish these to the used event broker.
+
+  Please find more information at
+  https://github.com/backstage/backstage/tree/master/plugins/events-backend-module-aws-sqs/README.md.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-tasks@0.0.0-nightly-20221115024001
+  - @backstage/plugin-events-node@0.0.0-nightly-20221115024001
+  - @backstage/types@0.0.0-nightly-20221115024001
+  - @backstage/backend-plugin-api@0.0.0-nightly-20221115024001
+  - @backstage/config@0.0.0-nightly-20221115024001

package/README.md

@@ -0,0 +1,42 @@
+# events-backend-module-aws-sqs
+
+Welcome to the `events-backend-module-aws-sqs` backend plugin!
+
+This plugin is a module for the `events-backend` backend plugin
+and extends it with an `AwsSqsConsumingEventPublisher`.
+
+This event publisher will allow you to receive events from
+an AWS SQS queue and will publish these to the used event broker.
+
+## Configuration
+
+The polled AWS SQS queues depend on your configuration:
+
+```yaml
+events:
+  modules:
+    awsSqs:
+      awsSqsConsumingEventPublisher:
+        topics:
+          topicName1: # replace with actual topic name as expected by subscribers
+            queue:
+              url: 'https://sqs.us-east-2.amazonaws.com/123456789012/MyQueue'
+              region: us-east-2
+              # visibilityTimeout - as HumanDuration; defaults to queue-based config
+              # waitTime - as HumanDuration; defaults to max of 20 seconds (long polling)
+            # timeout - as HumanDuration; timeout for the task execution
+            # waitTimeAfterEmptyReceive - as HumanDuration; time to wait before a retry when there was no message.
+          topicName2:
+            # [...]
+```
+
+## Installation
+
+1. Install the [`events-backend` plugin](../events-backend/README.md).
+2. Install this module
+3. Add your configuration.
+
+```bash
+# From your Backstage root directory
+yarn add --cwd packages/backend @backstage/plugin-events-backend-module-aws-sqs
+```

package/alpha/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@backstage/plugin-events-backend-module-aws-sqs",
+  "version": "0.0.0-nightly-20221115024001",
+  "main": "../dist/index.cjs.js",
+  "types": "../dist/index.alpha.d.ts"
+}

package/config.d.ts

@@ -0,0 +1,78 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { HumanDuration } from '@backstage/types';
+
+export interface Config {
+  events?: {
+    modules?: {
+      /**
+       * events-backend-module-aws-sqs plugin configuration.
+       */
+      awsSqs?: {
+        /**
+         * Configuration for AwsSqsConsumingEventPublisher.
+         */
+        awsSqsConsumingEventPublisher?: {
+          /**
+           * Contains a record per topic for which an AWS SQS queue
+           * should be used as source of events.
+           */
+          topics: Record<
+            string,
+            {
+              /**
+               * (Required) Queue-related configuration.
+               */
+              queue: {
+                /**
+                 * (Required) The region of the AWS SQS queue.
+                 */
+                region: string;
+                /**
+                 * (Required) The absolute URL for the AWS SQS queue to be used.
+                 */
+                url: string;
+                /**
+                 * (Optional) Visibility timeout for messages in flight.
+                 */
+                visibilityTimeout: HumanDuration;
+                /**
+                 * (Optional) Wait time when polling for available messages.
+                 * Default: 20 seconds.
+                 */
+                waitTime: HumanDuration;
+              };
+              /**
+               * (Optional) Timeout for the task execution which includes polling for messages
+               * and publishing the events to the event broker
+               * and the wait time after empty receives.
+               *
+               * Must be greater than `queue.waitTime` + `waitTimeAfterEmptyReceive`.
+               */
+              timeout: HumanDuration;
+              /**
+               * (Optional) Wait time before polling again if no message was received.
+               * Default: 1 minute.
+               */
+              waitTimeAfterEmptyReceive: HumanDuration;
+            }
+          >;
+        };
+      };
+    };
+  };
+}

package/dist/index.alpha.d.ts

@@ -0,0 +1,53 @@
+/**
+ * The module "sqs" for the Backstage backend plugin "events"
+ * adding an AWS SQS-based publisher,
+ * receiving events from an AWS SQS queue and passing it to the
+ * internal event broker.
+ *
+ * @packageDocumentation
+ */
+
+import { BackendFeature } from '@backstage/backend-plugin-api';
+import { Config } from '@backstage/config';
+import { EventBroker } from '@backstage/plugin-events-node';
+import { EventPublisher } from '@backstage/plugin-events-node';
+import { Logger } from 'winston';
+import { PluginTaskScheduler } from '@backstage/backend-tasks';
+
+/**
+ * Publishes events received from an AWS SQS queue.
+ * The message payload will be used as event payload and passed to registered subscribers.
+ *
+ * @public
+ */
+export declare class AwsSqsConsumingEventPublisher implements EventPublisher {
+    private readonly logger;
+    private readonly scheduler;
+    private readonly topic;
+    private readonly receiveParams;
+    private readonly sqs;
+    private readonly queueUrl;
+    private readonly taskTimeoutSeconds;
+    private readonly waitTimeAfterEmptyReceiveMs;
+    private eventBroker?;
+    static fromConfig(env: {
+        config: Config;
+        logger: Logger;
+        scheduler: PluginTaskScheduler;
+    }): AwsSqsConsumingEventPublisher[];
+    private constructor();
+    setEventBroker(eventBroker: EventBroker): Promise<void>;
+    private start;
+    private deleteMessages;
+    private consumeMessages;
+    private sleep;
+}
+
+/**
+ * AWS SQS module for the Events plugin.
+ *
+ * @alpha
+ */
+export declare const awsSqsConsumingEventPublisherEventsModule: (options?: undefined) => BackendFeature;
+
+export { }

package/dist/index.beta.d.ts

@@ -0,0 +1,48 @@
+/**
+ * The module "sqs" for the Backstage backend plugin "events"
+ * adding an AWS SQS-based publisher,
+ * receiving events from an AWS SQS queue and passing it to the
+ * internal event broker.
+ *
+ * @packageDocumentation
+ */
+
+import { BackendFeature } from '@backstage/backend-plugin-api';
+import { Config } from '@backstage/config';
+import { EventBroker } from '@backstage/plugin-events-node';
+import { EventPublisher } from '@backstage/plugin-events-node';
+import { Logger } from 'winston';
+import { PluginTaskScheduler } from '@backstage/backend-tasks';
+
+/**
+ * Publishes events received from an AWS SQS queue.
+ * The message payload will be used as event payload and passed to registered subscribers.
+ *
+ * @public
+ */
+export declare class AwsSqsConsumingEventPublisher implements EventPublisher {
+    private readonly logger;
+    private readonly scheduler;
+    private readonly topic;
+    private readonly receiveParams;
+    private readonly sqs;
+    private readonly queueUrl;
+    private readonly taskTimeoutSeconds;
+    private readonly waitTimeAfterEmptyReceiveMs;
+    private eventBroker?;
+    static fromConfig(env: {
+        config: Config;
+        logger: Logger;
+        scheduler: PluginTaskScheduler;
+    }): AwsSqsConsumingEventPublisher[];
+    private constructor();
+    setEventBroker(eventBroker: EventBroker): Promise<void>;
+    private start;
+    private deleteMessages;
+    private consumeMessages;
+    private sleep;
+}
+
+/* Excluded from this release type: awsSqsConsumingEventPublisherEventsModule */
+
+export { }

package/dist/index.cjs.js

@@ -0,0 +1,219 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var clientSqs = require('@aws-sdk/client-sqs');
+var luxon = require('luxon');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var pluginEventsNode = require('@backstage/plugin-events-node');
+
+const CONFIG_PREFIX_MODULE = "events.modules.awsSqs.";
+const CONFIG_PREFIX_PUBLISHER = `${CONFIG_PREFIX_MODULE}awsSqsConsumingEventPublisher.`;
+const DEFAULT_WAIT_TIME_AFTER_EMPTY_RECEIVE = { minutes: 1 };
+const MAX_WAIT_SECONDS = 20;
+function readOptionalHumanDuration(config, key) {
+  return config.getOptional(key);
+}
+function readOptionalDuration(config, key) {
+  const duration = readOptionalHumanDuration(config, key);
+  return duration ? luxon.Duration.fromObject(duration) : void 0;
+}
+function readConfig(config) {
+  var _a, _b;
+  const key = `${CONFIG_PREFIX_PUBLISHER}topics`;
+  const topics = config.getOptionalConfig(key);
+  return (_b = (_a = topics == null ? void 0 : topics.keys()) == null ? void 0 : _a.map((topic) => {
+    var _a2, _b2, _c;
+    const topicConfig = topics.getConfig(topic);
+    const keyPrefix = `${key}.${topic}.`;
+    const pollingWaitTime = luxon.Duration.fromObject(
+      (_a2 = readOptionalHumanDuration(topicConfig, "queue.waitTime")) != null ? _a2 : {
+        seconds: MAX_WAIT_SECONDS
+      }
+    );
+    if (pollingWaitTime.valueOf() < 0 || pollingWaitTime.as("seconds") > MAX_WAIT_SECONDS) {
+      throw new Error(
+        `${keyPrefix}queue.waitTime must be within 0..${MAX_WAIT_SECONDS} seconds.`
+      );
+    }
+    const queueUrl = topicConfig.getString("queue.url");
+    const region = topicConfig.getString("queue.region");
+    const visibilityTimeout = readOptionalDuration(
+      topicConfig,
+      "queue.visibilityTimeout"
+    );
+    const waitTimeAfterEmptyReceive = luxon.Duration.fromObject(
+      (_b2 = readOptionalHumanDuration(topicConfig, "waitTimeAfterEmptyReceive")) != null ? _b2 : DEFAULT_WAIT_TIME_AFTER_EMPTY_RECEIVE
+    );
+    if (waitTimeAfterEmptyReceive.valueOf() < 0) {
+      throw new Error(
+        `The ${keyPrefix}waitTimeAfterEmptyReceive must not be negative.`
+      );
+    }
+    const timeout = (_c = readOptionalDuration(topicConfig, "timeout")) != null ? _c : pollingWaitTime.plus(waitTimeAfterEmptyReceive).plus(luxon.Duration.fromObject({ seconds: 180 }));
+    if (timeout.valueOf() <= pollingWaitTime.valueOf() + waitTimeAfterEmptyReceive.valueOf()) {
+      throw new Error(
+        `The ${keyPrefix}timeout must be greater than ${keyPrefix}queue.waitTime + ${keyPrefix}waitTimeAfterEmptyReceive.`
+      );
+    }
+    return {
+      pollingWaitTime,
+      queueUrl,
+      region,
+      timeout,
+      topic,
+      visibilityTimeout,
+      waitTimeAfterEmptyReceive
+    };
+  })) != null ? _b : [];
+}
+
+class AwsSqsConsumingEventPublisher {
+  constructor(logger, scheduler, config) {
+    this.logger = logger;
+    this.scheduler = scheduler;
+    var _a;
+    this.topic = config.topic;
+    this.receiveParams = {
+      MaxNumberOfMessages: 10,
+      MessageAttributeNames: ["All"],
+      QueueUrl: config.queueUrl,
+      VisibilityTimeout: (_a = config.visibilityTimeout) == null ? void 0 : _a.as("seconds"),
+      WaitTimeSeconds: config.pollingWaitTime.as("seconds")
+    };
+    this.sqs = new clientSqs.SQSClient({ region: config.region });
+    this.queueUrl = config.queueUrl;
+    this.taskTimeoutSeconds = config.timeout.as("seconds");
+    this.waitTimeAfterEmptyReceiveMs = config.waitTimeAfterEmptyReceive.as("milliseconds");
+  }
+  static fromConfig(env) {
+    return readConfig(env.config).map(
+      (config) => new AwsSqsConsumingEventPublisher(env.logger, env.scheduler, config)
+    );
+  }
+  async setEventBroker(eventBroker) {
+    this.eventBroker = eventBroker;
+    return this.start();
+  }
+  async start() {
+    const id = `events.awsSqs.publisher:${this.topic}`;
+    const logger = this.logger.child({
+      class: AwsSqsConsumingEventPublisher.prototype.constructor.name,
+      taskId: id
+    });
+    await this.scheduler.scheduleTask({
+      id,
+      frequency: { seconds: 0 },
+      timeout: { seconds: this.taskTimeoutSeconds },
+      scope: "local",
+      fn: async () => {
+        try {
+          const numMessages = await this.consumeMessages();
+          if (numMessages === 0) {
+            await this.sleep(this.waitTimeAfterEmptyReceiveMs);
+          }
+        } catch (error) {
+          logger.error(error);
+        }
+      }
+    });
+  }
+  async deleteMessages(messages) {
+    if (!messages) {
+      return;
+    }
+    const deleteParams = {
+      QueueUrl: this.queueUrl,
+      Entries: messages.map((message, index) => {
+        var _a;
+        return {
+          Id: (_a = message.MessageId) != null ? _a : `message-${index}`,
+          ReceiptHandle: message.ReceiptHandle
+        };
+      })
+    };
+    try {
+      const result = await this.sqs.send(
+        new clientSqs.DeleteMessageBatchCommand(deleteParams)
+      );
+      if (result.Failed) {
+        this.logger.error(
+          `Failed to delete ${result.Failed.length} of ${messages.length} messages from AWS SQS ${this.queueUrl}. First: ${result.Failed[0].Message}`
+        );
+      }
+    } catch (error) {
+      this.logger.error(
+        `Failed to delete message from AWS SQS ${this.queueUrl}`,
+        error
+      );
+    }
+  }
+  async consumeMessages() {
+    var _a, _b, _c;
+    try {
+      const data = await this.sqs.send(
+        new clientSqs.ReceiveMessageCommand(this.receiveParams)
+      );
+      (_a = data.Messages) == null ? void 0 : _a.forEach((message) => {
+        var _a2;
+        const eventPayload = JSON.parse(message.Body);
+        const metadata = {};
+        Object.keys((_a2 = message.MessageAttributes) != null ? _a2 : {}).forEach((key) => {
+          var _a3;
+          const attrValue = message.MessageAttributes[key];
+          if (!attrValue || !attrValue.DataType || !["String", "Number"].includes(attrValue.DataType)) {
+            return;
+          }
+          const value = (_a3 = attrValue.StringListValues) != null ? _a3 : attrValue.StringValue;
+          if (value !== void 0) {
+            metadata[key] = value;
+          }
+        });
+        this.eventBroker.publish({
+          topic: this.topic,
+          eventPayload,
+          metadata
+        });
+      });
+      await this.deleteMessages(data.Messages);
+      return (_c = (_b = data.Messages) == null ? void 0 : _b.length) != null ? _c : 0;
+    } catch (error) {
+      this.logger.error(
+        `Failed to receive events from AWS SQS ${this.queueUrl}`,
+        error
+      );
+      return 0;
+    }
+  }
+  sleep(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+  }
+}
+
+const awsSqsConsumingEventPublisherEventsModule = backendPluginApi.createBackendModule({
+  pluginId: "events",
+  moduleId: "awsSqsConsumingEventPublisherEventsModule",
+  register(env) {
+    env.registerInit({
+      deps: {
+        config: backendPluginApi.configServiceRef,
+        events: pluginEventsNode.eventsExtensionPoint,
+        logger: backendPluginApi.loggerServiceRef,
+        scheduler: backendPluginApi.schedulerServiceRef
+      },
+      async init({ config, events, logger, scheduler }) {
+        const winstonLogger = backendPluginApi.loggerToWinstonLogger(logger);
+        const sqs = AwsSqsConsumingEventPublisher.fromConfig({
+          config,
+          logger: winstonLogger,
+          scheduler
+        });
+        events.addPublishers(sqs);
+      }
+    });
+  }
+});
+
+exports.AwsSqsConsumingEventPublisher = AwsSqsConsumingEventPublisher;
+exports.awsSqsConsumingEventPublisherEventsModule = awsSqsConsumingEventPublisherEventsModule;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/publisher/config.ts","../src/publisher/AwsSqsConsumingEventPublisher.ts","../src/service/AwsSqsConsumingEventPublisherEventsModule.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\nimport { HumanDuration, JsonObject } from '@backstage/types';\nimport { Duration } from 'luxon';\n\nconst CONFIG_PREFIX_MODULE = 'events.modules.awsSqs.';\nconst CONFIG_PREFIX_PUBLISHER = `${CONFIG_PREFIX_MODULE}awsSqsConsumingEventPublisher.`;\nconst DEFAULT_WAIT_TIME_AFTER_EMPTY_RECEIVE = { minutes: 1 };\nconst MAX_WAIT_SECONDS = 20;\n\nexport interface AwsSqsEventSourceConfig {\n  pollingWaitTime: Duration;\n  queueUrl: string;\n  region: string;\n  timeout: Duration;\n  topic: string;\n  visibilityTimeout?: Duration;\n  waitTimeAfterEmptyReceive: Duration;\n}\n\n// TODO(pjungermann): validation could be improved similar to `convertToHumanDuration` at @backstage/backend-tasks\nfunction readOptionalHumanDuration(\n  config: Config,\n  key: string,\n): HumanDuration | undefined {\n  return config.getOptional<JsonObject>(key) as HumanDuration;\n}\n\nfunction readOptionalDuration(\n  config: Config,\n  key: string,\n): Duration | undefined {\n  const duration = readOptionalHumanDuration(config, key);\n  return duration ? Duration.fromObject(duration) : undefined;\n}\n\nexport function readConfig(config: Config): AwsSqsEventSourceConfig[] {\n  const key = `${CONFIG_PREFIX_PUBLISHER}topics`;\n  const topics = config.getOptionalConfig(key);\n\n  return (\n    topics?.keys()?.map(topic => {\n      const topicConfig = topics.getConfig(topic);\n      const keyPrefix = `${key}.${topic}.`;\n\n      // queue config:\n      const pollingWaitTime = Duration.fromObject(\n        readOptionalHumanDuration(topicConfig, 'queue.waitTime') ?? {\n          seconds: MAX_WAIT_SECONDS,\n        },\n      );\n      if (\n        pollingWaitTime.valueOf() < 0 ||\n        pollingWaitTime.as('seconds') > MAX_WAIT_SECONDS\n      ) {\n        throw new Error(\n          `${keyPrefix}queue.waitTime must be within 0..${MAX_WAIT_SECONDS} seconds.`,\n        );\n      }\n      const queueUrl = topicConfig.getString('queue.url');\n      const region = topicConfig.getString('queue.region');\n      const visibilityTimeout = readOptionalDuration(\n        topicConfig,\n        'queue.visibilityTimeout',\n      );\n\n      // task:\n      const waitTimeAfterEmptyReceive = Duration.fromObject(\n        readOptionalHumanDuration(topicConfig, 'waitTimeAfterEmptyReceive') ??\n          DEFAULT_WAIT_TIME_AFTER_EMPTY_RECEIVE,\n      );\n      if (waitTimeAfterEmptyReceive.valueOf() < 0) {\n        throw new Error(\n          `The ${keyPrefix}waitTimeAfterEmptyReceive must not be negative.`,\n        );\n      }\n      const timeout =\n        readOptionalDuration(topicConfig, 'timeout') ??\n        pollingWaitTime\n          .plus(waitTimeAfterEmptyReceive)\n          .plus(Duration.fromObject({ seconds: 180 }));\n      if (\n        timeout.valueOf() <=\n        pollingWaitTime.valueOf() + waitTimeAfterEmptyReceive.valueOf()\n      ) {\n        throw new Error(\n          `The ${keyPrefix}timeout must be greater than ${keyPrefix}queue.waitTime + ${keyPrefix}waitTimeAfterEmptyReceive.`,\n        );\n      }\n\n      return {\n        pollingWaitTime,\n        queueUrl,\n        region,\n        timeout,\n        topic,\n        visibilityTimeout,\n        waitTimeAfterEmptyReceive,\n      };\n    }) ?? []\n  );\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  DeleteMessageBatchCommand,\n  Message,\n  ReceiveMessageCommand,\n  ReceiveMessageCommandInput,\n  SQSClient,\n} from '@aws-sdk/client-sqs';\nimport { PluginTaskScheduler } from '@backstage/backend-tasks';\nimport { Config } from '@backstage/config';\nimport { EventBroker, EventPublisher } from '@backstage/plugin-events-node';\nimport { Logger } from 'winston';\nimport { AwsSqsEventSourceConfig, readConfig } from './config';\n\n/**\n * Publishes events received from an AWS SQS queue.\n * The message payload will be used as event payload and passed to registered subscribers.\n *\n * @public\n */\n// TODO(pjungermann): add prom metrics? (see plugins/catalog-backend/src/util/metrics.ts, etc.)\nexport class AwsSqsConsumingEventPublisher implements EventPublisher {\n  private readonly topic: string;\n  private readonly receiveParams: ReceiveMessageCommandInput;\n  private readonly sqs: SQSClient;\n  private readonly queueUrl: string;\n  private readonly taskTimeoutSeconds: number;\n  private readonly waitTimeAfterEmptyReceiveMs;\n  private eventBroker?: EventBroker;\n\n  static fromConfig(env: {\n    config: Config;\n    logger: Logger;\n    scheduler: PluginTaskScheduler;\n  }): AwsSqsConsumingEventPublisher[] {\n    return readConfig(env.config).map(\n      config =>\n        new AwsSqsConsumingEventPublisher(env.logger, env.scheduler, config),\n    );\n  }\n\n  private constructor(\n    private readonly logger: Logger,\n    private readonly scheduler: PluginTaskScheduler,\n    config: AwsSqsEventSourceConfig,\n  ) {\n    this.topic = config.topic;\n\n    this.receiveParams = {\n      MaxNumberOfMessages: 10,\n      MessageAttributeNames: ['All'],\n      QueueUrl: config.queueUrl,\n      VisibilityTimeout: config.visibilityTimeout?.as('seconds'),\n      WaitTimeSeconds: config.pollingWaitTime.as('seconds'),\n    };\n    this.sqs = new SQSClient({ region: config.region });\n    this.queueUrl = config.queueUrl;\n\n    this.taskTimeoutSeconds = config.timeout.as('seconds');\n    this.waitTimeAfterEmptyReceiveMs =\n      config.waitTimeAfterEmptyReceive.as('milliseconds');\n  }\n\n  async setEventBroker(eventBroker: EventBroker): Promise<void> {\n    this.eventBroker = eventBroker;\n    return this.start();\n  }\n\n  private async start(): Promise<void> {\n    const id = `events.awsSqs.publisher:${this.topic}`;\n    const logger = this.logger.child({\n      class: AwsSqsConsumingEventPublisher.prototype.constructor.name,\n      taskId: id,\n    });\n\n    await this.scheduler.scheduleTask({\n      id: id,\n      frequency: { seconds: 0 },\n      timeout: { seconds: this.taskTimeoutSeconds },\n      scope: 'local',\n      fn: async () => {\n        try {\n          const numMessages = await this.consumeMessages();\n          if (numMessages === 0) {\n            await this.sleep(this.waitTimeAfterEmptyReceiveMs);\n          }\n        } catch (error) {\n          logger.error(error);\n        }\n      },\n    });\n  }\n\n  private async deleteMessages(messages?: Message[]): Promise<void> {\n    if (!messages) {\n      return;\n    }\n\n    const deleteParams = {\n      QueueUrl: this.queueUrl,\n      Entries: messages.map((message, index) => {\n        return {\n          Id: message.MessageId ?? `message-${index}`,\n          ReceiptHandle: message.ReceiptHandle,\n        };\n      }),\n    };\n\n    try {\n      const result = await this.sqs.send(\n        new DeleteMessageBatchCommand(deleteParams),\n      );\n      if (result.Failed) {\n        this.logger.error(\n          `Failed to delete ${result.Failed!.length} of ${\n            messages.length\n          } messages from AWS SQS ${this.queueUrl}. First: ${\n            result.Failed[0].Message\n          }`,\n        );\n      }\n    } catch (error) {\n      this.logger.error(\n        `Failed to delete message from AWS SQS ${this.queueUrl}`,\n        error,\n      );\n    }\n  }\n\n  private async consumeMessages(): Promise<number> {\n    try {\n      const data = await this.sqs.send(\n        new ReceiveMessageCommand(this.receiveParams),\n      );\n\n      data.Messages?.forEach(message => {\n        const eventPayload = JSON.parse(message.Body!);\n\n        const metadata: Record<string, string | string[]> = {};\n        Object.keys(message.MessageAttributes ?? {}).forEach(key => {\n          const attrValue = message.MessageAttributes![key];\n          if (\n            !attrValue ||\n            !attrValue.DataType ||\n            !['String', 'Number'].includes(attrValue.DataType)\n          ) {\n            return;\n          }\n\n          const value = attrValue.StringListValues ?? attrValue.StringValue;\n          if (value !== undefined) {\n            metadata[key] = value;\n          }\n        });\n\n        this.eventBroker!.publish({\n          topic: this.topic,\n          eventPayload,\n          metadata,\n        });\n      });\n      await this.deleteMessages(data.Messages);\n      return data.Messages?.length ?? 0;\n    } catch (error) {\n      this.logger.error(\n        `Failed to receive events from AWS SQS ${this.queueUrl}`,\n        error,\n      );\n      return 0;\n    }\n  }\n\n  private sleep(ms: number): Promise<void> {\n    return new Promise<void>(resolve => setTimeout(resolve, ms));\n  }\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  configServiceRef,\n  createBackendModule,\n  loggerServiceRef,\n  loggerToWinstonLogger,\n  schedulerServiceRef,\n} from '@backstage/backend-plugin-api';\nimport { eventsExtensionPoint } from '@backstage/plugin-events-node';\nimport { AwsSqsConsumingEventPublisher } from '../publisher/AwsSqsConsumingEventPublisher';\n\n/**\n * AWS SQS module for the Events plugin.\n *\n * @alpha\n */\nexport const awsSqsConsumingEventPublisherEventsModule = createBackendModule({\n  pluginId: 'events',\n  moduleId: 'awsSqsConsumingEventPublisherEventsModule',\n  register(env) {\n    env.registerInit({\n      deps: {\n        config: configServiceRef,\n        events: eventsExtensionPoint,\n        logger: loggerServiceRef,\n        scheduler: schedulerServiceRef,\n      },\n      async init({ config, events, logger, scheduler }) {\n        const winstonLogger = loggerToWinstonLogger(logger);\n        const sqs = AwsSqsConsumingEventPublisher.fromConfig({\n          config: config,\n          logger: winstonLogger,\n          scheduler: scheduler,\n        });\n\n        events.addPublishers(sqs);\n      },\n    });\n  },\n});\n"],"names":["Duration","_a","_b","SQSClient","DeleteMessageBatchCommand","ReceiveMessageCommand","createBackendModule","configServiceRef","eventsExtensionPoint","loggerServiceRef","schedulerServiceRef","loggerToWinstonLogger"],"mappings":";;;;;;;;;AAoBA,MAAM,oBAAuB,GAAA,wBAAA,CAAA;AAC7B,MAAM,0BAA0B,CAAG,EAAA,oBAAA,CAAA,8BAAA,CAAA,CAAA;AACnC,MAAM,qCAAA,GAAwC,EAAE,OAAA,EAAS,CAAE,EAAA,CAAA;AAC3D,MAAM,gBAAmB,GAAA,EAAA,CAAA;AAazB,SAAS,yBAAA,CACP,QACA,GAC2B,EAAA;AAC3B,EAAO,OAAA,MAAA,CAAO,YAAwB,GAAG,CAAA,CAAA;AAC3C,CAAA;AAEA,SAAS,oBAAA,CACP,QACA,GACsB,EAAA;AACtB,EAAM,MAAA,QAAA,GAAW,yBAA0B,CAAA,MAAA,EAAQ,GAAG,CAAA,CAAA;AACtD,EAAA,OAAO,QAAW,GAAAA,cAAA,CAAS,UAAW,CAAA,QAAQ,CAAI,GAAA,KAAA,CAAA,CAAA;AACpD,CAAA;AAEO,SAAS,WAAW,MAA2C,EAAA;AAnDtE,EAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAoDE,EAAA,MAAM,MAAM,CAAG,EAAA,uBAAA,CAAA,MAAA,CAAA,CAAA;AACf,EAAM,MAAA,MAAA,GAAS,MAAO,CAAA,iBAAA,CAAkB,GAAG,CAAA,CAAA;AAE3C,EAAA,OAAA,CACE,EAAQ,GAAA,CAAA,EAAA,GAAA,MAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,MAAA,CAAA,IAAA,EAAA,KAAR,IAAgB,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,GAAA,CAAI,CAAS,KAAA,KAAA;AAxDjC,IAAA,IAAAC,KAAAC,GAAA,EAAA,EAAA,CAAA;AAyDM,IAAM,MAAA,WAAA,GAAc,MAAO,CAAA,SAAA,CAAU,KAAK,CAAA,CAAA;AAC1C,IAAM,MAAA,SAAA,GAAY,GAAG,GAAO,CAAA,CAAA,EAAA,KAAA,CAAA,CAAA,CAAA,CAAA;AAG5B,IAAA,MAAM,kBAAkBF,cAAS,CAAA,UAAA;AAAA,MAAA,CAC/BC,MAAA,yBAA0B,CAAA,WAAA,EAAa,gBAAgB,CAAA,KAAvD,OAAAA,GAA4D,GAAA;AAAA,QAC1D,OAAS,EAAA,gBAAA;AAAA,OACX;AAAA,KACF,CAAA;AACA,IACE,IAAA,eAAA,CAAgB,SAAY,GAAA,CAAA,IAC5B,gBAAgB,EAAG,CAAA,SAAS,IAAI,gBAChC,EAAA;AACA,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,GAAG,SAA6C,CAAA,iCAAA,EAAA,gBAAA,CAAA,SAAA,CAAA;AAAA,OAClD,CAAA;AAAA,KACF;AACA,IAAM,MAAA,QAAA,GAAW,WAAY,CAAA,SAAA,CAAU,WAAW,CAAA,CAAA;AAClD,IAAM,MAAA,MAAA,GAAS,WAAY,CAAA,SAAA,CAAU,cAAc,CAAA,CAAA;AACnD,IAAA,MAAM,iBAAoB,GAAA,oBAAA;AAAA,MACxB,WAAA;AAAA,MACA,yBAAA;AAAA,KACF,CAAA;AAGA,IAAA,MAAM,4BAA4BD,cAAS,CAAA,UAAA;AAAA,MAAA,CACzCE,MAAA,yBAA0B,CAAA,WAAA,EAAa,2BAA2B,CAAA,KAAlE,OAAAA,GACE,GAAA,qCAAA;AAAA,KACJ,CAAA;AACA,IAAI,IAAA,yBAAA,CAA0B,OAAQ,EAAA,GAAI,CAAG,EAAA;AAC3C,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAO,IAAA,EAAA,SAAA,CAAA,+CAAA,CAAA;AAAA,OACT,CAAA;AAAA,KACF;AACA,IAAA,MAAM,WACJ,EAAqB,GAAA,oBAAA,CAAA,WAAA,EAAa,SAAS,CAAA,KAA3C,YACA,eACG,CAAA,IAAA,CAAK,yBAAyB,CAAA,CAC9B,KAAKF,cAAS,CAAA,UAAA,CAAW,EAAE,OAAS,EAAA,GAAA,EAAK,CAAC,CAAA,CAAA;AAC/C,IACE,IAAA,OAAA,CAAQ,SACR,IAAA,eAAA,CAAgB,SAAY,GAAA,yBAAA,CAA0B,SACtD,EAAA;AACA,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,IAAA,EAAO,yCAAyC,SAA6B,CAAA,iBAAA,EAAA,SAAA,CAAA,0BAAA,CAAA;AAAA,OAC/E,CAAA;AAAA,KACF;AAEA,IAAO,OAAA;AAAA,MACL,eAAA;AAAA,MACA,QAAA;AAAA,MACA,MAAA;AAAA,MACA,OAAA;AAAA,MACA,KAAA;AAAA,MACA,iBAAA;AAAA,MACA,yBAAA;AAAA,KACF,CAAA;AAAA,GACF,CAAA,KA1DA,YA0DM,EAAC,CAAA;AAEX;;AChFO,MAAM,6BAAwD,CAAA;AAAA,EAoB3D,WAAA,CACW,MACA,EAAA,SAAA,EACjB,MACA,EAAA;AAHiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA,CAAA;AA1DrB,IAAA,IAAA,EAAA,CAAA;AA6DI,IAAA,IAAA,CAAK,QAAQ,MAAO,CAAA,KAAA,CAAA;AAEpB,IAAA,IAAA,CAAK,aAAgB,GAAA;AAAA,MACnB,mBAAqB,EAAA,EAAA;AAAA,MACrB,qBAAA,EAAuB,CAAC,KAAK,CAAA;AAAA,MAC7B,UAAU,MAAO,CAAA,QAAA;AAAA,MACjB,iBAAmB,EAAA,CAAA,EAAA,GAAA,MAAA,CAAO,iBAAP,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAA0B,EAAG,CAAA,SAAA,CAAA;AAAA,MAChD,eAAiB,EAAA,MAAA,CAAO,eAAgB,CAAA,EAAA,CAAG,SAAS,CAAA;AAAA,KACtD,CAAA;AACA,IAAA,IAAA,CAAK,MAAM,IAAIG,mBAAA,CAAU,EAAE,MAAQ,EAAA,MAAA,CAAO,QAAQ,CAAA,CAAA;AAClD,IAAA,IAAA,CAAK,WAAW,MAAO,CAAA,QAAA,CAAA;AAEvB,IAAA,IAAA,CAAK,kBAAqB,GAAA,MAAA,CAAO,OAAQ,CAAA,EAAA,CAAG,SAAS,CAAA,CAAA;AACrD,IAAA,IAAA,CAAK,2BACH,GAAA,MAAA,CAAO,yBAA0B,CAAA,EAAA,CAAG,cAAc,CAAA,CAAA;AAAA,GACtD;AAAA,EA/BA,OAAO,WAAW,GAIkB,EAAA;AAClC,IAAO,OAAA,UAAA,CAAW,GAAI,CAAA,MAAM,CAAE,CAAA,GAAA;AAAA,MAC5B,YACE,IAAI,6BAAA,CAA8B,IAAI,MAAQ,EAAA,GAAA,CAAI,WAAW,MAAM,CAAA;AAAA,KACvE,CAAA;AAAA,GACF;AAAA,EAwBA,MAAM,eAAe,WAAyC,EAAA;AAC5D,IAAA,IAAA,CAAK,WAAc,GAAA,WAAA,CAAA;AACnB,IAAA,OAAO,KAAK,KAAM,EAAA,CAAA;AAAA,GACpB;AAAA,EAEA,MAAc,KAAuB,GAAA;AACnC,IAAM,MAAA,EAAA,GAAK,2BAA2B,IAAK,CAAA,KAAA,CAAA,CAAA,CAAA;AAC3C,IAAM,MAAA,MAAA,GAAS,IAAK,CAAA,MAAA,CAAO,KAAM,CAAA;AAAA,MAC/B,KAAA,EAAO,6BAA8B,CAAA,SAAA,CAAU,WAAY,CAAA,IAAA;AAAA,MAC3D,MAAQ,EAAA,EAAA;AAAA,KACT,CAAA,CAAA;AAED,IAAM,MAAA,IAAA,CAAK,UAAU,YAAa,CAAA;AAAA,MAChC,EAAA;AAAA,MACA,SAAA,EAAW,EAAE,OAAA,EAAS,CAAE,EAAA;AAAA,MACxB,OAAS,EAAA,EAAE,OAAS,EAAA,IAAA,CAAK,kBAAmB,EAAA;AAAA,MAC5C,KAAO,EAAA,OAAA;AAAA,MACP,IAAI,YAAY;AACd,QAAI,IAAA;AACF,UAAM,MAAA,WAAA,GAAc,MAAM,IAAA,CAAK,eAAgB,EAAA,CAAA;AAC/C,UAAA,IAAI,gBAAgB,CAAG,EAAA;AACrB,YAAM,MAAA,IAAA,CAAK,KAAM,CAAA,IAAA,CAAK,2BAA2B,CAAA,CAAA;AAAA,WACnD;AAAA,iBACO,KAAP,EAAA;AACA,UAAA,MAAA,CAAO,MAAM,KAAK,CAAA,CAAA;AAAA,SACpB;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,MAAc,eAAe,QAAqC,EAAA;AAChE,IAAA,IAAI,CAAC,QAAU,EAAA;AACb,MAAA,OAAA;AAAA,KACF;AAEA,IAAA,MAAM,YAAe,GAAA;AAAA,MACnB,UAAU,IAAK,CAAA,QAAA;AAAA,MACf,OAAS,EAAA,QAAA,CAAS,GAAI,CAAA,CAAC,SAAS,KAAU,KAAA;AAnHhD,QAAA,IAAA,EAAA,CAAA;AAoHQ,QAAO,OAAA;AAAA,UACL,EAAI,EAAA,CAAA,EAAA,GAAA,OAAA,CAAQ,SAAR,KAAA,IAAA,GAAA,EAAA,GAAqB,CAAW,QAAA,EAAA,KAAA,CAAA,CAAA;AAAA,UACpC,eAAe,OAAQ,CAAA,aAAA;AAAA,SACzB,CAAA;AAAA,OACD,CAAA;AAAA,KACH,CAAA;AAEA,IAAI,IAAA;AACF,MAAM,MAAA,MAAA,GAAS,MAAM,IAAA,CAAK,GAAI,CAAA,IAAA;AAAA,QAC5B,IAAIC,oCAA0B,YAAY,CAAA;AAAA,OAC5C,CAAA;AACA,MAAA,IAAI,OAAO,MAAQ,EAAA;AACjB,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,UACV,CAAA,iBAAA,EAAoB,MAAO,CAAA,MAAA,CAAQ,MACjC,CAAA,IAAA,EAAA,QAAA,CAAS,gCACe,IAAK,CAAA,QAAA,CAAA,SAAA,EAC7B,MAAO,CAAA,MAAA,CAAO,CAAG,CAAA,CAAA,OAAA,CAAA,CAAA;AAAA,SAErB,CAAA;AAAA,OACF;AAAA,aACO,KAAP,EAAA;AACA,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,yCAAyC,IAAK,CAAA,QAAA,CAAA,CAAA;AAAA,QAC9C,KAAA;AAAA,OACF,CAAA;AAAA,KACF;AAAA,GACF;AAAA,EAEA,MAAc,eAAmC,GAAA;AAhJnD,IAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AAiJI,IAAI,IAAA;AACF,MAAM,MAAA,IAAA,GAAO,MAAM,IAAA,CAAK,GAAI,CAAA,IAAA;AAAA,QAC1B,IAAIC,+BAAsB,CAAA,IAAA,CAAK,aAAa,CAAA;AAAA,OAC9C,CAAA;AAEA,MAAK,CAAA,EAAA,GAAA,IAAA,CAAA,QAAA,KAAL,IAAe,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,OAAA,CAAQ,CAAW,OAAA,KAAA;AAtJxC,QAAAJ,IAAAA,GAAAA,CAAAA;AAuJQ,QAAA,MAAM,YAAe,GAAA,IAAA,CAAK,KAAM,CAAA,OAAA,CAAQ,IAAK,CAAA,CAAA;AAE7C,QAAA,MAAM,WAA8C,EAAC,CAAA;AACrD,QAAO,MAAA,CAAA,IAAA,CAAA,CAAKA,GAAA,GAAA,OAAA,CAAQ,iBAAR,KAAA,IAAA,GAAAA,MAA6B,EAAE,CAAE,CAAA,OAAA,CAAQ,CAAO,GAAA,KAAA;AA1JpE,UAAAA,IAAAA,GAAAA,CAAAA;AA2JU,UAAM,MAAA,SAAA,GAAY,QAAQ,iBAAmB,CAAA,GAAA,CAAA,CAAA;AAC7C,UAAA,IACE,CAAC,SAAA,IACD,CAAC,SAAA,CAAU,QACX,IAAA,CAAC,CAAC,QAAA,EAAU,QAAQ,CAAA,CAAE,QAAS,CAAA,SAAA,CAAU,QAAQ,CACjD,EAAA;AACA,YAAA,OAAA;AAAA,WACF;AAEA,UAAA,MAAM,SAAQA,GAAA,GAAA,SAAA,CAAU,gBAAV,KAAA,IAAA,GAAAA,MAA8B,SAAU,CAAA,WAAA,CAAA;AACtD,UAAA,IAAI,UAAU,KAAW,CAAA,EAAA;AACvB,YAAA,QAAA,CAAS,GAAO,CAAA,GAAA,KAAA,CAAA;AAAA,WAClB;AAAA,SACD,CAAA,CAAA;AAED,QAAA,IAAA,CAAK,YAAa,OAAQ,CAAA;AAAA,UACxB,OAAO,IAAK,CAAA,KAAA;AAAA,UACZ,YAAA;AAAA,UACA,QAAA;AAAA,SACD,CAAA,CAAA;AAAA,OACH,CAAA,CAAA;AACA,MAAM,MAAA,IAAA,CAAK,cAAe,CAAA,IAAA,CAAK,QAAQ,CAAA,CAAA;AACvC,MAAA,OAAA,CAAO,EAAK,GAAA,CAAA,EAAA,GAAA,IAAA,CAAA,QAAA,KAAL,IAAe,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,MAAA,KAAf,IAAyB,GAAA,EAAA,GAAA,CAAA,CAAA;AAAA,aACzB,KAAP,EAAA;AACA,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,yCAAyC,IAAK,CAAA,QAAA,CAAA,CAAA;AAAA,QAC9C,KAAA;AAAA,OACF,CAAA;AACA,MAAO,OAAA,CAAA,CAAA;AAAA,KACT;AAAA,GACF;AAAA,EAEQ,MAAM,EAA2B,EAAA;AACvC,IAAA,OAAO,IAAI,OAAc,CAAA,CAAA,OAAA,KAAW,UAAW,CAAA,OAAA,EAAS,EAAE,CAAC,CAAA,CAAA;AAAA,GAC7D;AACF;;AC/JO,MAAM,4CAA4CK,oCAAoB,CAAA;AAAA,EAC3E,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,2CAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,MAAQ,EAAAC,iCAAA;AAAA,QACR,MAAQ,EAAAC,qCAAA;AAAA,QACR,MAAQ,EAAAC,iCAAA;AAAA,QACR,SAAW,EAAAC,oCAAA;AAAA,OACb;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,QAAQ,MAAQ,EAAA,MAAA,EAAQ,WAAa,EAAA;AAChD,QAAM,MAAA,aAAA,GAAgBC,uCAAsB,MAAM,CAAA,CAAA;AAClD,QAAM,MAAA,GAAA,GAAM,8BAA8B,UAAW,CAAA;AAAA,UACnD,MAAA;AAAA,UACA,MAAQ,EAAA,aAAA;AAAA,UACR,SAAA;AAAA,SACD,CAAA,CAAA;AAED,QAAA,MAAA,CAAO,cAAc,GAAG,CAAA,CAAA;AAAA,OAC1B;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,48 @@
+/**
+ * The module "sqs" for the Backstage backend plugin "events"
+ * adding an AWS SQS-based publisher,
+ * receiving events from an AWS SQS queue and passing it to the
+ * internal event broker.
+ *
+ * @packageDocumentation
+ */
+
+import { BackendFeature } from '@backstage/backend-plugin-api';
+import { Config } from '@backstage/config';
+import { EventBroker } from '@backstage/plugin-events-node';
+import { EventPublisher } from '@backstage/plugin-events-node';
+import { Logger } from 'winston';
+import { PluginTaskScheduler } from '@backstage/backend-tasks';
+
+/**
+ * Publishes events received from an AWS SQS queue.
+ * The message payload will be used as event payload and passed to registered subscribers.
+ *
+ * @public
+ */
+export declare class AwsSqsConsumingEventPublisher implements EventPublisher {
+    private readonly logger;
+    private readonly scheduler;
+    private readonly topic;
+    private readonly receiveParams;
+    private readonly sqs;
+    private readonly queueUrl;
+    private readonly taskTimeoutSeconds;
+    private readonly waitTimeAfterEmptyReceiveMs;
+    private eventBroker?;
+    static fromConfig(env: {
+        config: Config;
+        logger: Logger;
+        scheduler: PluginTaskScheduler;
+    }): AwsSqsConsumingEventPublisher[];
+    private constructor();
+    setEventBroker(eventBroker: EventBroker): Promise<void>;
+    private start;
+    private deleteMessages;
+    private consumeMessages;
+    private sleep;
+}
+
+/* Excluded from this release type: awsSqsConsumingEventPublisherEventsModule */
+
+export { }

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@backstage/plugin-events-backend-module-aws-sqs",
+  "version": "0.0.0-nightly-20221115024001",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "alphaTypes": "dist/index.alpha.d.ts",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "backend-plugin-module"
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build --experimental-type-build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "dependencies": {
+    "@aws-sdk/client-sqs": "^3.0.0",
+    "@backstage/backend-plugin-api": "^0.0.0-nightly-20221115024001",
+    "@backstage/backend-tasks": "^0.0.0-nightly-20221115024001",
+    "@backstage/config": "^0.0.0-nightly-20221115024001",
+    "@backstage/plugin-events-node": "^0.0.0-nightly-20221115024001",
+    "@backstage/types": "^0.0.0-nightly-20221115024001",
+    "luxon": "^3.0.0",
+    "winston": "^3.2.1"
+  },
+  "devDependencies": {
+    "@backstage/backend-common": "^0.0.0-nightly-20221115024001",
+    "@backstage/backend-test-utils": "^0.0.0-nightly-20221115024001",
+    "@backstage/cli": "^0.0.0-nightly-20221115024001",
+    "@backstage/plugin-events-backend-test-utils": "^0.0.0-nightly-20221115024001",
+    "aws-sdk-client-mock": "^2.0.0"
+  },
+  "files": [
+    "alpha",
+    "config.d.ts",
+    "dist"
+  ],
+  "configSchema": "config.d.ts"
+}