@aws-sdk/middleware-sdk-sqs 3.502.0 → 3.507.0

package/dist-cjs/index.js

@@ -20,11 +20,15 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  getQueueUrlPlugin: () => getQueueUrlPlugin,
   getReceiveMessagePlugin: () => getReceiveMessagePlugin,
   getSendMessageBatchPlugin: () => getSendMessageBatchPlugin,
   getSendMessagePlugin: () => getSendMessagePlugin,
+  queueUrlMiddleware: () => queueUrlMiddleware,
+  queueUrlMiddlewareOptions: () => queueUrlMiddlewareOptions,
   receiveMessageMiddleware: () => receiveMessageMiddleware,
   receiveMessageMiddlewareOptions: () => receiveMessageMiddlewareOptions,
+  resolveQueueUrlConfig: () => resolveQueueUrlConfig,
   sendMessageBatchMiddleware: () => sendMessageBatchMiddleware,
   sendMessageBatchMiddlewareOptions: () => sendMessageBatchMiddlewareOptions,
   sendMessageMiddleware: () => sendMessageMiddleware,
@@ -32,6 +36,53 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
+// src/queue-url.ts
+var import_smithy_client = require("@smithy/smithy-client");
+var resolveQueueUrlConfig = /* @__PURE__ */ __name((config) => {
+  return {
+    ...config,
+    useQueueUrlAsEndpoint: config.useQueueUrlAsEndpoint ?? true
+  };
+}, "resolveQueueUrlConfig");
+function queueUrlMiddleware({ useQueueUrlAsEndpoint, endpoint }) {
+  return (next, context) => {
+    return async (args) => {
+      var _a;
+      const { input } = args;
+      const resolvedEndpoint = context.endpointV2;
+      if (!endpoint && input.QueueUrl && resolvedEndpoint && useQueueUrlAsEndpoint) {
+        const logger = context.logger instanceof import_smithy_client.NoOpLogger || !((_a = context.logger) == null ? void 0 : _a.warn) ? console : context.logger;
+        try {
+          const queueUrl = new URL(input.QueueUrl);
+          const queueUrlOrigin = new URL(queueUrl.origin);
+          if (resolvedEndpoint.url.origin !== queueUrlOrigin.origin) {
+            logger.warn(
+              `QueueUrl=${input.QueueUrl} differs from SQSClient resolved endpoint=${resolvedEndpoint.url.toString()}, using QueueUrl host as endpoint.
+Set [endpoint=string] or [useQueueUrlAsEndpoint=false] on the SQSClient.`
+            );
+            resolvedEndpoint.url = queueUrlOrigin;
+          }
+        } catch (e) {
+          logger.warn(e);
+        }
+      }
+      return next(args);
+    };
+  };
+}
+__name(queueUrlMiddleware, "queueUrlMiddleware");
+var queueUrlMiddlewareOptions = {
+  name: "queueUrlMiddleware",
+  relation: "after",
+  toMiddleware: "endpointV2Middleware",
+  override: true
+};
+var getQueueUrlPlugin = /* @__PURE__ */ __name((config) => ({
+  applyToStack: (clientStack) => {
+    clientStack.addRelativeTo(queueUrlMiddleware(config), queueUrlMiddlewareOptions);
+  }
+}), "getQueueUrlPlugin");
+
 // src/receive-message.ts
 var import_util_hex_encoding = require("@smithy/util-hex-encoding");
 var import_util_utf8 = require("@smithy/util-utf8");
@@ -138,6 +189,10 @@ var getSendMessageBatchPlugin = /* @__PURE__ */ __name((config) => ({
 // Annotate the CommonJS export names for ESM import in node:
 
 0 && (module.exports = {
+  resolveQueueUrlConfig,
+  queueUrlMiddleware,
+  queueUrlMiddlewareOptions,
+  getQueueUrlPlugin,
   receiveMessageMiddleware,
   receiveMessageMiddlewareOptions,
   getReceiveMessagePlugin,

package/dist-cjs/queue-url.js

@@ -0,0 +1 @@
+module.exports = require("./index.js");

package/dist-es/index.js

@@ -1,3 +1,4 @@
+export * from "./queue-url";
 export * from "./receive-message";
 export * from "./send-message";
 export * from "./send-message-batch";

package/dist-es/queue-url.js

@@ -0,0 +1,42 @@
+import { NoOpLogger } from "@smithy/smithy-client";
+export const resolveQueueUrlConfig = (config) => {
+    return {
+        ...config,
+        useQueueUrlAsEndpoint: config.useQueueUrlAsEndpoint ?? true,
+    };
+};
+export function queueUrlMiddleware({ useQueueUrlAsEndpoint, endpoint }) {
+    return (next, context) => {
+        return async (args) => {
+            const { input } = args;
+            const resolvedEndpoint = context.endpointV2;
+            if (!endpoint && input.QueueUrl && resolvedEndpoint && useQueueUrlAsEndpoint) {
+                const logger = context.logger instanceof NoOpLogger || !context.logger?.warn ? console : context.logger;
+                try {
+                    const queueUrl = new URL(input.QueueUrl);
+                    const queueUrlOrigin = new URL(queueUrl.origin);
+                    if (resolvedEndpoint.url.origin !== queueUrlOrigin.origin) {
+                        logger.warn(`QueueUrl=${input.QueueUrl} differs from SQSClient resolved endpoint=${resolvedEndpoint.url.toString()}, using QueueUrl host as endpoint.
+Set [endpoint=string] or [useQueueUrlAsEndpoint=false] on the SQSClient.`);
+                        resolvedEndpoint.url = queueUrlOrigin;
+                    }
+                }
+                catch (e) {
+                    logger.warn(e);
+                }
+            }
+            return next(args);
+        };
+    };
+}
+export const queueUrlMiddlewareOptions = {
+    name: "queueUrlMiddleware",
+    relation: "after",
+    toMiddleware: "endpointV2Middleware",
+    override: true,
+};
+export const getQueueUrlPlugin = (config) => ({
+    applyToStack: (clientStack) => {
+        clientStack.addRelativeTo(queueUrlMiddleware(config), queueUrlMiddlewareOptions);
+    },
+});

package/dist-types/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./queue-url";
 export * from "./receive-message";
 export * from "./send-message";
 export * from "./send-message-batch";

package/dist-types/queue-url.d.ts

@@ -0,0 +1,33 @@
+import { Endpoint, EndpointV2, FinalizeHandlerArguments, FinalizeHandlerOutput, HandlerExecutionContext, Pluggable, Provider, RelativeMiddlewareOptions } from "@aws-sdk/types";
+/**
+ * @public
+ */
+export interface QueueUrlInputConfig {
+    /**
+     * In cases where a QueueUrl is given as input, that
+     * will be preferred as the request endpoint.
+     *
+     * Set this value to false to ignore the QueueUrl and use the
+     * client's resolved endpoint, which may be a custom endpoint.
+     */
+    useQueueUrlAsEndpoint?: boolean;
+}
+export interface QueueUrlResolvedConfig {
+    useQueueUrlAsEndpoint: boolean;
+}
+export interface PreviouslyResolved {
+    endpoint?: string | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+}
+export declare const resolveQueueUrlConfig: <T>(config: T & PreviouslyResolved & QueueUrlInputConfig) => T & QueueUrlResolvedConfig;
+/**
+ * @internal
+ */
+export declare function queueUrlMiddleware({ useQueueUrlAsEndpoint, endpoint }: QueueUrlResolvedConfig & PreviouslyResolved): <Output extends object>(next: (args: FinalizeHandlerArguments<any>) => Promise<FinalizeHandlerOutput<Output>>, context: HandlerExecutionContext) => (args: FinalizeHandlerArguments<any>) => Promise<FinalizeHandlerOutput<Output>>;
+/**
+ * @internal
+ */
+export declare const queueUrlMiddlewareOptions: RelativeMiddlewareOptions;
+/**
+ * @internal
+ */
+export declare const getQueueUrlPlugin: (config: QueueUrlResolvedConfig) => Pluggable<any, any>;

package/dist-types/ts3.4/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./queue-url";
 export * from "./receive-message";
 export * from "./send-message";
 export * from "./send-message-batch";

package/dist-types/ts3.4/queue-url.d.ts

@@ -0,0 +1,42 @@
+import {
+  Endpoint,
+  EndpointV2,
+  FinalizeHandlerArguments,
+  FinalizeHandlerOutput,
+  HandlerExecutionContext,
+  Pluggable,
+  Provider,
+  RelativeMiddlewareOptions,
+} from "@aws-sdk/types";
+export interface QueueUrlInputConfig {
+  useQueueUrlAsEndpoint?: boolean;
+}
+export interface QueueUrlResolvedConfig {
+  useQueueUrlAsEndpoint: boolean;
+}
+export interface PreviouslyResolved {
+  endpoint?:
+    | string
+    | Endpoint
+    | Provider<Endpoint>
+    | EndpointV2
+    | Provider<EndpointV2>;
+}
+export declare const resolveQueueUrlConfig: <T>(
+  config: T & PreviouslyResolved & QueueUrlInputConfig
+) => T & QueueUrlResolvedConfig;
+export declare function queueUrlMiddleware({
+  useQueueUrlAsEndpoint,
+  endpoint,
+}: QueueUrlResolvedConfig & PreviouslyResolved): <Output extends object>(
+  next: (
+    args: FinalizeHandlerArguments<any>
+  ) => Promise<FinalizeHandlerOutput<Output>>,
+  context: HandlerExecutionContext
+) => (
+  args: FinalizeHandlerArguments<any>
+) => Promise<FinalizeHandlerOutput<Output>>;
+export declare const queueUrlMiddlewareOptions: RelativeMiddlewareOptions;
+export declare const getQueueUrlPlugin: (
+  config: QueueUrlResolvedConfig
+) => Pluggable<any, any>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/middleware-sdk-sqs",
-  "version": "3.502.0",
+  "version": "3.507.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline middleware-sdk-sqs",
@@ -22,6 +22,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@aws-sdk/types": "3.502.0",
+    "@smithy/smithy-client": "^2.3.1",
     "@smithy/types": "^2.9.1",
     "@smithy/util-hex-encoding": "^2.1.1",
     "@smithy/util-utf8": "^2.1.1",