move handler init types to @smithy/types

Author: kuhe

.changeset/dry-balloons-smell.md

@@ -2,6 +2,7 @@
 "@smithy/fetch-http-handler": minor
 "@smithy/node-http-handler": minor
 "@smithy/protocol-http": minor
+"@smithy/types": minor
 ---
 
-add static factory for http handlers
+move default fetch and http handler ctor types to the types package

.changeset/many-ads-float.md renamed to .changeset/sixty-fireants-pay.md

@@ -0,0 +1,5 @@
+---
+"@smithy/signature-v4": patch
+---
+
+add readme content for signature-v4

.changeset/witty-pugs-love.md

@@ -6,27 +6,8 @@ import { requestTimeout } from "./request-timeout";
 
 declare let AbortController: any;
 
-/**
- * Represents the http options that can be passed to a browser http client.
- */
-export interface FetchHttpHandlerOptions {
-  /**
-   * The number of milliseconds a request can take before being automatically
-   * terminated.
-   */
-  requestTimeout?: number;
-
-  /**
-   * Whether to allow the request to outlive the page. Default value is false.
-   *
-   * There may be limitations to the payload size, number of concurrent requests,
-   * request duration etc. when using keepalive in browsers.
-   *
-   * These may change over time, so look for up to date information about
-   * these limitations before enabling keepalive.
-   */
-  keepAlive?: boolean;
-}
+import type { FetchHttpHandlerOptions } from '@smithy/types';
+export { FetchHttpHandlerOptions }
 
 type FetchHttpHandlerConfig = FetchHttpHandlerOptions;
 

packages/fetch-http-handler/src/fetch-http-handler.ts

@@ -1,8 +1,9 @@
 import { HttpHandler, HttpRequest, HttpResponse } from "@smithy/protocol-http";
 import { buildQueryString } from "@smithy/querystring-builder";
+import type { NodeHttpHandlerOptions } from '@smithy/types';
 import { HttpHandlerOptions, Provider } from "@smithy/types";
 import { Agent as hAgent, request as hRequest } from "http";
-import { Agent as hsAgent, request as hsRequest, RequestOptions } from "https";
+import { Agent as hsAgent, request as hsRequest,RequestOptions } from "https";
 
 import { NODEJS_TIMEOUT_ERROR_CODES } from "./constants";
 import { getTransformedHeaders } from "./get-transformed-headers";
@@ -11,35 +12,7 @@ import { setSocketKeepAlive } from "./set-socket-keep-alive";
 import { setSocketTimeout } from "./set-socket-timeout";
 import { writeRequestBody } from "./write-request-body";
 
-/**
- * Represents the http options that can be passed to a node http client.
- */
-export interface NodeHttpHandlerOptions {
-  /**
-   * The maximum time in milliseconds that the connection phase of a request
-   * may take before the connection attempt is abandoned.
-   *
-   * Defaults to 0, which disables the timeout.
-   */
-  connectionTimeout?: number;
-
-  /**
-   * The number of milliseconds a request can take before automatically being terminated.
-   * Defaults to 0, which disables the timeout.
-   */
-  requestTimeout?: number;
-
-  /**
-   * @deprecated Use {@link requestTimeout}
-   *
-   * The maximum time in milliseconds that a socket may remain idle before it
-   * is closed.
-   */
-  socketTimeout?: number;
-
-  httpAgent?: hAgent;
-  httpsAgent?: hsAgent;
-}
+export { NodeHttpHandlerOptions };
 
 interface ResolvedNodeHttpHandlerConfig {
   requestTimeout?: number;

packages/node-http-handler/src/node-http-handler.ts

@@ -16,13 +16,6 @@
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
   "types": "./dist-types/index.d.ts",
-  "browser": {
-    "./dist-es/httpHandlerInitialization": "./dist-es/httpHandlerInitialization.browser"
-  },
-  "react-native": {
-    "./dist-es/httpHandlerInitialization": "./dist-es/httpHandlerInitialization.browser",
-    "./dist-cjs/httpHandlerInitialization": "./dist-cjs/httpHandlerInitialization.browser"
-  },
   "author": {
     "name": "AWS Smithy Team",
     "email": "",

packages/protocol-http/package.json

@@ -0,0 +1,68 @@
+import type { Agent as hAgent } from "http";
+import type { Agent as hsAgent } from "https";
+
+/**
+ *
+ * This type represents an alternate client constructor option for the entry
+ * "requestHandler". Instead of providing an instance of a requestHandler, the user
+ * may provide the requestHandler's constructor options for either the
+ * NodeHttpHandler or FetchHttpHandler.
+ *
+ * For other RequestHandlers like HTTP2 or WebSocket,
+ * constructor parameter passthrough is not currently available.
+ *
+ * @public
+ */
+export type RequestHandlerParams = NodeHttpHandlerOptions | FetchHttpHandlerOptions;
+
+/**
+ * Represents the http options that can be passed to a node http client.
+ */
+export interface NodeHttpHandlerOptions {
+  /**
+   * The maximum time in milliseconds that the connection phase of a request
+   * may take before the connection attempt is abandoned.
+   *
+   * Defaults to 0, which disables the timeout.
+   */
+  connectionTimeout?: number;
+
+  /**
+   * The number of milliseconds a request can take before automatically being terminated.
+   * Defaults to 0, which disables the timeout.
+   */
+  requestTimeout?: number;
+
+  /**
+   * @deprecated Use {@link requestTimeout}
+   *
+   * The maximum time in milliseconds that a socket may remain idle before it
+   * is closed.
+   */
+  socketTimeout?: number;
+
+  httpAgent?: hAgent;
+  httpsAgent?: hsAgent;
+}
+
+/**
+ * Represents the http options that can be passed to a browser http client.
+ */
+export interface FetchHttpHandlerOptions {
+  /**
+   * The number of milliseconds a request can take before being automatically
+   * terminated.
+   */
+  requestTimeout?: number;
+
+  /**
+   * Whether to allow the request to outlive the page. Default value is false.
+   *
+   * There may be limitations to the payload size, number of concurrent requests,
+   * request duration etc. when using keepalive in browsers.
+   *
+   * These may change over time, so look for up to date information about
+   * these limitations before enabling keepalive.
+   */
+  keepAlive?: boolean;
+}