@aws-sdk/middleware-user-agent 3.662.0 → 3.666.0

package/dist-cjs/index.js

@@ -21,6 +21,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  DEFAULT_UA_APP_ID: () => DEFAULT_UA_APP_ID,
   getUserAgentMiddlewareOptions: () => getUserAgentMiddlewareOptions,
   getUserAgentPlugin: () => getUserAgentPlugin,
   resolveUserAgentConfig: () => resolveUserAgentConfig,
@@ -29,10 +30,33 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 
 // src/configurations.ts
+var import_core = require("@smithy/core");
+var DEFAULT_UA_APP_ID = void 0;
+function isValidUserAgentAppId(appId) {
+  if (appId === void 0) {
+    return true;
+  }
+  return typeof appId === "string" && appId.length <= 50;
+}
+__name(isValidUserAgentAppId, "isValidUserAgentAppId");
 function resolveUserAgentConfig(input) {
+  const normalizedAppIdProvider = (0, import_core.normalizeProvider)(input.userAgentAppId ?? DEFAULT_UA_APP_ID);
   return {
     ...input,
-    customUserAgent: typeof input.customUserAgent === "string" ? [[input.customUserAgent]] : input.customUserAgent
+    customUserAgent: typeof input.customUserAgent === "string" ? [[input.customUserAgent]] : input.customUserAgent,
+    userAgentAppId: async () => {
+      var _a, _b;
+      const appId = await normalizedAppIdProvider();
+      if (!isValidUserAgentAppId(appId)) {
+        const logger = ((_b = (_a = input.logger) == null ? void 0 : _a.constructor) == null ? void 0 : _b.name) === "NoOpLogger" || !input.logger ? console : input.logger;
+        if (typeof appId !== "string") {
+          logger == null ? void 0 : logger.warn("userAgentAppId must be a string or undefined.");
+        } else if (appId.length > 50) {
+          logger == null ? void 0 : logger.warn("The provided userAgentAppId exceeds the maximum length of 50 characters.");
+        }
+      }
+      return appId;
+    }
   };
 }
 __name(resolveUserAgentConfig, "resolveUserAgentConfig");
@@ -41,6 +65,27 @@ __name(resolveUserAgentConfig, "resolveUserAgentConfig");
 var import_util_endpoints = require("@aws-sdk/util-endpoints");
 var import_protocol_http = require("@smithy/protocol-http");
 
+// src/check-features.ts
+var import_core2 = require("@aws-sdk/core");
+async function checkFeatures(context, config, args) {
+  var _a;
+  const request = args.request;
+  if (typeof config.accountIdEndpointMode === "function") {
+    switch (await ((_a = config.accountIdEndpointMode) == null ? void 0 : _a.call(config))) {
+      case "disabled":
+        (0, import_core2.setFeature)(context, "ACCOUNT_ID_MODE_DISABLED", "Q");
+        break;
+      case "preferred":
+        (0, import_core2.setFeature)(context, "ACCOUNT_ID_MODE_PREFERRED", "P");
+        break;
+      case "required":
+        (0, import_core2.setFeature)(context, "ACCOUNT_ID_MODE_REQUIRED", "R");
+        break;
+    }
+  }
+}
+__name(checkFeatures, "checkFeatures");
+
 // src/constants.ts
 var USER_AGENT = "user-agent";
 var X_AMZ_USER_AGENT = "x-amz-user-agent";
@@ -50,16 +95,48 @@ var UA_NAME_ESCAPE_REGEX = /[^\!\$\%\&\'\*\+\-\.\^\_\`\|\~\d\w]/g;
 var UA_VALUE_ESCAPE_REGEX = /[^\!\$\%\&\'\*\+\-\.\^\_\`\|\~\d\w\#]/g;
 var UA_ESCAPE_CHAR = "-";
 
+// src/encode-features.ts
+var BYTE_LIMIT = 1024;
+function encodeFeatures(features) {
+  let buffer = "";
+  for (const key in features) {
+    const val = features[key];
+    if (buffer.length + val.length + 1 <= BYTE_LIMIT) {
+      if (buffer.length) {
+        buffer += "," + val;
+      } else {
+        buffer += val;
+      }
+      continue;
+    }
+    break;
+  }
+  return buffer;
+}
+__name(encodeFeatures, "encodeFeatures");
+
 // src/user-agent-middleware.ts
 var userAgentMiddleware = /* @__PURE__ */ __name((options) => (next, context) => async (args) => {
-  var _a, _b;
+  var _a, _b, _c, _d;
   const { request } = args;
-  if (!import_protocol_http.HttpRequest.isInstance(request))
+  if (!import_protocol_http.HttpRequest.isInstance(request)) {
     return next(args);
+  }
   const { headers } = request;
   const userAgent = ((_a = context == null ? void 0 : context.userAgent) == null ? void 0 : _a.map(escapeUserAgent)) || [];
   const defaultUserAgent = (await options.defaultUserAgentProvider()).map(escapeUserAgent);
-  const customUserAgent = ((_b = options == null ? void 0 : options.customUserAgent) == null ? void 0 : _b.map(escapeUserAgent)) || [];
+  await checkFeatures(context, options, args);
+  const awsContext = context;
+  defaultUserAgent.push(
+    `m/${encodeFeatures(
+      Object.assign({}, (_b = context.__smithy_context) == null ? void 0 : _b.features, (_c = awsContext.__aws_sdk_context) == null ? void 0 : _c.features)
+    )}`
+  );
+  const customUserAgent = ((_d = options == null ? void 0 : options.customUserAgent) == null ? void 0 : _d.map(escapeUserAgent)) || [];
+  const appId = await options.userAgentAppId();
+  if (appId) {
+    defaultUserAgent.push(escapeUserAgent([`app/${appId}`]));
+  }
   const prefix = (0, import_util_endpoints.getUserAgentPrefix)();
   const sdkUserAgentValue = (prefix ? [prefix] : []).concat([...defaultUserAgent, ...userAgent, ...customUserAgent]).join(SPACE);
   const normalUAValue = [
@@ -115,6 +192,7 @@ var getUserAgentPlugin = /* @__PURE__ */ __name((config) => ({
 // Annotate the CommonJS export names for ESM import in node:
 
 0 && (module.exports = {
+  DEFAULT_UA_APP_ID,
   resolveUserAgentConfig,
   userAgentMiddleware,
   getUserAgentMiddlewareOptions,

package/dist-es/check-features.js

@@ -0,0 +1,17 @@
+import { setFeature } from "@aws-sdk/core";
+export async function checkFeatures(context, config, args) {
+    const request = args.request;
+    if (typeof config.accountIdEndpointMode === "function") {
+        switch (await config.accountIdEndpointMode?.()) {
+            case "disabled":
+                setFeature(context, "ACCOUNT_ID_MODE_DISABLED", "Q");
+                break;
+            case "preferred":
+                setFeature(context, "ACCOUNT_ID_MODE_PREFERRED", "P");
+                break;
+            case "required":
+                setFeature(context, "ACCOUNT_ID_MODE_REQUIRED", "R");
+                break;
+        }
+    }
+}

package/dist-es/configurations.js

@@ -1,6 +1,28 @@
+import { normalizeProvider } from "@smithy/core";
+export const DEFAULT_UA_APP_ID = undefined;
+function isValidUserAgentAppId(appId) {
+    if (appId === undefined) {
+        return true;
+    }
+    return typeof appId === "string" && appId.length <= 50;
+}
 export function resolveUserAgentConfig(input) {
+    const normalizedAppIdProvider = normalizeProvider(input.userAgentAppId ?? DEFAULT_UA_APP_ID);
     return {
         ...input,
         customUserAgent: typeof input.customUserAgent === "string" ? [[input.customUserAgent]] : input.customUserAgent,
+        userAgentAppId: async () => {
+            const appId = await normalizedAppIdProvider();
+            if (!isValidUserAgentAppId(appId)) {
+                const logger = input.logger?.constructor?.name === "NoOpLogger" || !input.logger ? console : input.logger;
+                if (typeof appId !== "string") {
+                    logger?.warn("userAgentAppId must be a string or undefined.");
+                }
+                else if (appId.length > 50) {
+                    logger?.warn("The provided userAgentAppId exceeds the maximum length of 50 characters.");
+                }
+            }
+            return appId;
+        },
     };
 }

package/dist-es/encode-features.js

@@ -0,0 +1,18 @@
+const BYTE_LIMIT = 1024;
+export function encodeFeatures(features) {
+    let buffer = "";
+    for (const key in features) {
+        const val = features[key];
+        if (buffer.length + val.length + 1 <= BYTE_LIMIT) {
+            if (buffer.length) {
+                buffer += "," + val;
+            }
+            else {
+                buffer += val;
+            }
+            continue;
+        }
+        break;
+    }
+    return buffer;
+}

package/dist-es/user-agent-middleware.js

@@ -1,14 +1,24 @@
 import { getUserAgentPrefix } from "@aws-sdk/util-endpoints";
 import { HttpRequest } from "@smithy/protocol-http";
+import { checkFeatures } from "./check-features";
 import { SPACE, UA_ESCAPE_CHAR, UA_NAME_ESCAPE_REGEX, UA_NAME_SEPARATOR, UA_VALUE_ESCAPE_REGEX, USER_AGENT, X_AMZ_USER_AGENT, } from "./constants";
+import { encodeFeatures } from "./encode-features";
 export const userAgentMiddleware = (options) => (next, context) => async (args) => {
     const { request } = args;
-    if (!HttpRequest.isInstance(request))
+    if (!HttpRequest.isInstance(request)) {
         return next(args);
+    }
     const { headers } = request;
     const userAgent = context?.userAgent?.map(escapeUserAgent) || [];
     const defaultUserAgent = (await options.defaultUserAgentProvider()).map(escapeUserAgent);
+    await checkFeatures(context, options, args);
+    const awsContext = context;
+    defaultUserAgent.push(`m/${encodeFeatures(Object.assign({}, context.__smithy_context?.features, awsContext.__aws_sdk_context?.features))}`);
     const customUserAgent = options?.customUserAgent?.map(escapeUserAgent) || [];
+    const appId = await options.userAgentAppId();
+    if (appId) {
+        defaultUserAgent.push(escapeUserAgent([`app/${appId}`]));
+    }
     const prefix = getUserAgentPrefix();
     const sdkUserAgentValue = (prefix ? [prefix] : [])
         .concat([...defaultUserAgent, ...userAgent, ...customUserAgent])

package/dist-types/check-features.d.ts

@@ -0,0 +1,16 @@
+import type { AccountIdEndpointMode } from "@aws-sdk/core/account-id-endpoint";
+import type { AwsHandlerExecutionContext } from "@aws-sdk/types";
+import type { BuildHandlerArguments, Provider } from "@smithy/types";
+/**
+ * @internal
+ */
+type PreviouslyResolved = Partial<{
+    accountIdEndpointMode?: Provider<AccountIdEndpointMode>;
+}>;
+/**
+ * @internal
+ * Check for features that don't have a middleware activation site but
+ * may be detected on the context, client config, or request.
+ */
+export declare function checkFeatures(context: AwsHandlerExecutionContext, config: PreviouslyResolved, args: BuildHandlerArguments<any>): Promise<void>;
+export {};

package/dist-types/configurations.d.ts

@@ -1,4 +1,8 @@
-import { Provider, UserAgent } from "@smithy/types";
+import { Logger, Provider, UserAgent } from "@smithy/types";
+/**
+ * @internal
+ */
+export declare const DEFAULT_UA_APP_ID: undefined;
 /**
  * @public
  */
@@ -7,10 +11,15 @@ export interface UserAgentInputConfig {
      * The custom user agent header that would be appended to default one
      */
     customUserAgent?: string | UserAgent;
+    /**
+     * The application ID used to identify the application.
+     */
+    userAgentAppId?: string | undefined | Provider<string | undefined>;
 }
 interface PreviouslyResolved {
     defaultUserAgentProvider: Provider<UserAgent>;
     runtime: string;
+    logger?: Logger;
 }
 export interface UserAgentResolvedConfig {
     /**
@@ -26,6 +35,10 @@ export interface UserAgentResolvedConfig {
      * The runtime environment
      */
     runtime: string;
+    /**
+     * Resolved value for input config {config.userAgentAppId}
+     */
+    userAgentAppId: Provider<string | undefined>;
 }
 export declare function resolveUserAgentConfig<T>(input: T & PreviouslyResolved & UserAgentInputConfig): T & UserAgentResolvedConfig;
 export {};

package/dist-types/encode-features.d.ts

@@ -0,0 +1,5 @@
+import type { AwsSdkFeatures } from "@aws-sdk/types";
+/**
+ * @internal
+ */
+export declare function encodeFeatures(features: AwsSdkFeatures): string;

package/dist-types/ts3.4/check-features.d.ts

@@ -0,0 +1,12 @@
+import { AccountIdEndpointMode } from "@aws-sdk/core/account-id-endpoint";
+import { AwsHandlerExecutionContext } from "@aws-sdk/types";
+import { BuildHandlerArguments, Provider } from "@smithy/types";
+type PreviouslyResolved = Partial<{
+  accountIdEndpointMode?: Provider<AccountIdEndpointMode>;
+}>;
+export declare function checkFeatures(
+  context: AwsHandlerExecutionContext,
+  config: PreviouslyResolved,
+  args: BuildHandlerArguments<any>
+): Promise<void>;
+export {};

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

@@ -1,15 +1,19 @@
-import { Provider, UserAgent } from "@smithy/types";
+import { Logger, Provider, UserAgent } from "@smithy/types";
+export declare const DEFAULT_UA_APP_ID: undefined;
 export interface UserAgentInputConfig {
   customUserAgent?: string | UserAgent;
+  userAgentAppId?: string | undefined | Provider<string | undefined>;
 }
 interface PreviouslyResolved {
   defaultUserAgentProvider: Provider<UserAgent>;
   runtime: string;
+  logger?: Logger;
 }
 export interface UserAgentResolvedConfig {
   defaultUserAgentProvider: Provider<UserAgent>;
   customUserAgent?: UserAgent;
   runtime: string;
+  userAgentAppId: Provider<string | undefined>;
 }
 export declare function resolveUserAgentConfig<T>(
   input: T & PreviouslyResolved & UserAgentInputConfig

package/dist-types/ts3.4/encode-features.d.ts

@@ -0,0 +1,2 @@
+import { AwsSdkFeatures } from "@aws-sdk/types";
+export declare function encodeFeatures(features: AwsSdkFeatures): string;

package/dist-types/ts3.4/user-agent-middleware.d.ts

@@ -1,3 +1,4 @@
+import { AwsHandlerExecutionContext } from "@aws-sdk/types";
 import {
   AbsoluteLocation,
   BuildHandler,
@@ -11,7 +12,7 @@ export declare const userAgentMiddleware: (
   options: UserAgentResolvedConfig
 ) => <Output extends MetadataBearer>(
   next: BuildHandler<any, any>,
-  context: HandlerExecutionContext
+  context: HandlerExecutionContext | AwsHandlerExecutionContext
 ) => BuildHandler<any, any>;
 export declare const getUserAgentMiddlewareOptions: BuildHandlerOptions &
   AbsoluteLocation;

package/dist-types/user-agent-middleware.d.ts

@@ -1,3 +1,4 @@
+import type { AwsHandlerExecutionContext } from "@aws-sdk/types";
 import { AbsoluteLocation, BuildHandler, BuildHandlerOptions, HandlerExecutionContext, MetadataBearer, Pluggable } from "@smithy/types";
 import { UserAgentResolvedConfig } from "./configurations";
 /**
@@ -12,6 +13,6 @@ import { UserAgentResolvedConfig } from "./configurations";
  * config or middleware setting the `userAgent` context to generate desired user
  * agent.
  */
-export declare const userAgentMiddleware: (options: UserAgentResolvedConfig) => <Output extends MetadataBearer>(next: BuildHandler<any, any>, context: HandlerExecutionContext) => BuildHandler<any, any>;
+export declare const userAgentMiddleware: (options: UserAgentResolvedConfig) => <Output extends MetadataBearer>(next: BuildHandler<any, any>, context: HandlerExecutionContext | AwsHandlerExecutionContext) => BuildHandler<any, any>;
 export declare const getUserAgentMiddlewareOptions: BuildHandlerOptions & AbsoluteLocation;
 export declare const getUserAgentPlugin: (config: UserAgentResolvedConfig) => Pluggable<any, any>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/middleware-user-agent",
-  "version": "3.662.0",
+  "version": "3.666.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline middleware-user-agent",
@@ -22,8 +22,10 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@aws-sdk/types": "3.662.0",
-    "@aws-sdk/util-endpoints": "3.662.0",
+    "@aws-sdk/core": "3.666.0",
+    "@aws-sdk/types": "3.664.0",
+    "@aws-sdk/util-endpoints": "3.664.0",
+    "@smithy/core": "^2.4.8",
     "@smithy/protocol-http": "^4.1.4",
     "@smithy/types": "^3.5.0",
     "tslib": "^2.6.2"