@aws-sdk/middleware-user-agent 3.18.0 → 3.25.0

package/CHANGELOG.md

@@ -3,6 +3,47 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.25.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.24.0...v3.25.0) (2021-08-05)
+
+**Note:** Version bump only for package @aws-sdk/middleware-user-agent
+
+
+
+
+
+# [3.23.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.22.0...v3.23.0) (2021-07-23)
+
+
+### Bug Fixes
+
+* bump up tslib to 2.3.0 ([#2601](https://github.com/aws/aws-sdk-js-v3/issues/2601)) ([7040faa](https://github.com/aws/aws-sdk-js-v3/commit/7040faac07976c1dcfd5240675b82a2f275b2a55))
+
+
+
+
+
+# [3.22.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.21.0...v3.22.0) (2021-07-16)
+
+
+### Bug Fixes
+
+* **clients:** prefix `dist/` for typesVersions TS<4 ([#2580](https://github.com/aws/aws-sdk-js-v3/issues/2580)) ([dff5cd4](https://github.com/aws/aws-sdk-js-v3/commit/dff5cd4b6fa00453e938ce8f238c1542ee7ba3d6))
+
+
+
+
+
+# [3.20.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.19.0...v3.20.0) (2021-07-02)
+
+
+### Bug Fixes
+
+* replace prepublishOnly script with downlevel-dts ([#2537](https://github.com/aws/aws-sdk-js-v3/issues/2537)) ([63818a1](https://github.com/aws/aws-sdk-js-v3/commit/63818a1e47b08af56f092031a01bbbff0a9af590))
+
+
+
+
+
 # [3.18.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.17.0...v3.18.0) (2021-06-04)
 
 **Note:** Version bump only for package @aws-sdk/middleware-user-agent

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

@@ -0,0 +1,28 @@
+import { Provider, UserAgent } from "@aws-sdk/types";
+export interface UserAgentInputConfig {
+    /**
+     * The custom user agent header that would be appended to default one
+     */
+    customUserAgent?: string | UserAgent;
+}
+interface PreviouslyResolved {
+    defaultUserAgentProvider: Provider<UserAgent>;
+    runtime: string;
+}
+export interface UserAgentResolvedConfig {
+    /**
+     * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header.
+     * @internal
+     */
+    defaultUserAgentProvider: Provider<UserAgent>;
+    /**
+     * The custom user agent header that would be appended to default one
+     */
+    customUserAgent?: UserAgent;
+    /**
+     * The runtime environment
+     */
+    runtime: string;
+}
+export declare function resolveUserAgentConfig<T>(input: T & PreviouslyResolved & UserAgentInputConfig): T & UserAgentResolvedConfig;
+export {};

package/dist/types/ts3.4/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const USER_AGENT = "user-agent";
+export declare const X_AMZ_USER_AGENT = "x-amz-user-agent";
+export declare const SPACE = " ";
+export declare const UA_ESCAPE_REGEX: RegExp;

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

@@ -0,0 +1,2 @@
+export * from "./configurations";
+export * from "./user-agent-middleware";

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

@@ -0,0 +1,17 @@
+import { AbsoluteLocation, BuildHandler, BuildHandlerOptions, HandlerExecutionContext, MetadataBearer, Pluggable } from "@aws-sdk/types";
+import { UserAgentResolvedConfig } from "./configurations";
+/**
+ * Build user agent header sections from:
+ * 1. runtime-specific default user agent provider;
+ * 2. custom user agent from `customUserAgent` client config;
+ * 3. handler execution context set by internal SDK components;
+ * The built user agent will be set to `x-amz-user-agent` header for ALL the
+ * runtimes.
+ * Please note that any override to the `user-agent` or `x-amz-user-agent` header
+ * in the HTTP request is discouraged. Please use `customUserAgent` client
+ * 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 getUserAgentMiddlewareOptions: BuildHandlerOptions & AbsoluteLocation;
+export declare const getUserAgentPlugin: (config: UserAgentResolvedConfig) => Pluggable<any, any>;

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@aws-sdk/middleware-user-agent",
-  "version": "3.18.0",
+  "version": "3.25.0",
   "scripts": {
-    "prepublishOnly": "yarn build && downlevel-dts dist/types dist/types/ts3.4",
     "build:cjs": "tsc -p tsconfig.cjs.json",
     "build:es": "tsc -p tsconfig.es.json",
     "build": "yarn build:es && yarn build:cjs",
+    "downlevel-dts": "downlevel-dts dist/types dist/types/ts3.4",
     "test": "jest --passWithNoTests"
   },
   "main": "./dist/cjs/index.js",
@@ -17,12 +17,12 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@aws-sdk/protocol-http": "3.18.0",
-    "@aws-sdk/types": "3.18.0",
-    "tslib": "^2.0.0"
+    "@aws-sdk/protocol-http": "3.25.0",
+    "@aws-sdk/types": "3.25.0",
+    "tslib": "^2.3.0"
   },
   "devDependencies": {
-    "@aws-sdk/middleware-stack": "3.18.0",
+    "@aws-sdk/middleware-stack": "3.25.0",
     "@types/jest": "^26.0.4",
     "jest": "^26.1.0",
     "typescript": "~4.3.2"
@@ -32,8 +32,8 @@
   },
   "typesVersions": {
     "<4.0": {
-      "types/*": [
-        "types/ts3.4/*"
+      "dist/types/*": [
+        "dist/types/ts3.4/*"
       ]
     }
   },