chore: generate default endpoint ruleset (smithy-lang#1589)

Author: kuhe

.changeset/ten-islands-itch.md

@@ -0,0 +1,6 @@
+---
+"@smithy/middleware-endpoint": patch
+"@smithy/middleware-serde": patch
+---
+
+reduce usage of endpoints2.0 type adapter in public interfaces

packages/middleware-endpoint/src/resolveEndpointConfig.ts

@@ -56,7 +56,6 @@ export interface EndpointInputConfig<T extends EndpointParameters = EndpointPara
  */
 interface PreviouslyResolved<T extends EndpointParameters = EndpointParameters> {
   urlParser: UrlParser;
-  region: Provider<string>;
   endpointProvider: (params: T, context?: { logger?: Logger }) => EndpointV2;
   logger?: Logger;
   serviceId?: string;

packages/middleware-serde/src/serdePlugin.ts

@@ -30,8 +30,12 @@ export const serializerMiddlewareOption: SerializeHandlerOptions = {
   override: true,
 };
 
-// Type the modifies the EndpointBearer to make it compatible with Endpoints 2.0 change.
-// Must be removed after all clients has been onboard the Endpoints 2.0
+/**
+ * Modifies the EndpointBearer to make it compatible with Endpoints 2.0 change.
+ *
+ * @internal
+ * @deprecated
+ */
 export type V1OrV2Endpoint = {
   // for v2
   urlParser?: UrlParser;
@@ -49,7 +53,7 @@ export function getSerdePlugin<
   CommandSerdeContext extends SerdeContext = any,
   OutputType extends MetadataBearer = any,
 >(
-  config: V1OrV2Endpoint & SerdeFunctions,
+  config: SerdeFunctions,
   serializer: RequestSerializer<any, CommandSerdeContext>,
   deserializer: ResponseDeserializer<OutputType, any, CommandSerdeContext>
 ): Pluggable<InputType, OutputType> {

packages/middleware-serde/src/serializerMiddleware.ts

@@ -18,15 +18,17 @@ import type { V1OrV2Endpoint } from "./serdePlugin";
  */
 export const serializerMiddleware =
   <Input extends object = any, Output extends object = any, CommandSerdeContext extends SerdeContext = any>(
-    options: V1OrV2Endpoint & SerdeFunctions,
+    options: SerdeFunctions,
     serializer: RequestSerializer<any, CommandSerdeContext>
   ): SerializeMiddleware<Input, Output> =>
   (next: SerializeHandler<Input, Output>, context: HandlerExecutionContext): SerializeHandler<Input, Output> =>
   async (args: SerializeHandlerArguments<Input>): Promise<SerializeHandlerOutput<Output>> => {
+    const endpointConfig = options as V1OrV2Endpoint;
+
     const endpoint: Provider<Endpoint> =
-      context.endpointV2?.url && options.urlParser
-        ? async () => options.urlParser!(context.endpointV2!.url as URL)
-        : options.endpoint!;
+      context.endpointV2?.url && endpointConfig.urlParser
+        ? async () => endpointConfig.urlParser!(context.endpointV2!.url as URL)
+        : endpointConfig.endpoint!;
 
     if (!endpoint) {
       throw new Error("No valid endpoint provider available.");

private/smithy-rpcv2-cbor/package.json

@@ -27,6 +27,7 @@
     "@smithy/hash-node": "workspace:^",
     "@smithy/invalid-dependency": "workspace:^",
     "@smithy/middleware-content-length": "workspace:^",
+    "@smithy/middleware-endpoint": "workspace:^",
     "@smithy/middleware-retry": "workspace:^",
     "@smithy/middleware-serde": "workspace:^",
     "@smithy/middleware-stack": "workspace:^",
@@ -41,6 +42,7 @@
     "@smithy/util-body-length-node": "workspace:^",
     "@smithy/util-defaults-mode-browser": "workspace:^",
     "@smithy/util-defaults-mode-node": "workspace:^",
+    "@smithy/util-endpoints": "workspace:^",
     "@smithy/util-middleware": "workspace:^",
     "@smithy/util-retry": "workspace:^",
     "@smithy/util-utf8": "workspace:^",

private/smithy-rpcv2-cbor/src/RpcV2ProtocolClient.ts

@@ -33,15 +33,21 @@ import {
   SparseNullsOperationCommandInput,
   SparseNullsOperationCommandOutput,
 } from "./commands/SparseNullsOperationCommand";
+import {
+  ClientInputEndpointParameters,
+  ClientResolvedEndpointParameters,
+  EndpointParameters,
+  resolveClientEndpointParameters,
+} from "./endpoint/EndpointParameters";
 import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig";
 import { RuntimeExtension, RuntimeExtensionsConfig, resolveRuntimeExtensions } from "./runtimeExtensions";
 import {
-  CustomEndpointsInputConfig,
-  CustomEndpointsResolvedConfig,
-  resolveCustomEndpointsConfig,
-} from "@smithy/config-resolver";
-import { DefaultIdentityProviderConfig, getHttpAuthSchemePlugin, getHttpSigningPlugin } from "@smithy/core";
+  DefaultIdentityProviderConfig,
+  getHttpAuthSchemeEndpointRuleSetPlugin,
+  getHttpSigningPlugin,
+} from "@smithy/core";
 import { getContentLengthPlugin } from "@smithy/middleware-content-length";
+import { EndpointInputConfig, EndpointResolvedConfig, resolveEndpointConfig } from "@smithy/middleware-endpoint";
 import { RetryInputConfig, RetryResolvedConfig, getRetryPlugin, resolveRetryConfig } from "@smithy/middleware-retry";
 import { HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/protocol-http";
 import {
@@ -205,9 +211,10 @@ export interface ClientDefaults extends Partial<__SmithyConfiguration<__HttpHand
  */
 export type RpcV2ProtocolClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
   ClientDefaults &
-  CustomEndpointsInputConfig &
   RetryInputConfig &
-  HttpAuthSchemeInputConfig;
+  EndpointInputConfig<EndpointParameters> &
+  HttpAuthSchemeInputConfig &
+  ClientInputEndpointParameters;
 /**
  * @public
  *
@@ -221,9 +228,10 @@ export interface RpcV2ProtocolClientConfig extends RpcV2ProtocolClientConfigType
 export type RpcV2ProtocolClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
   Required<ClientDefaults> &
   RuntimeExtensionsConfig &
-  CustomEndpointsResolvedConfig &
   RetryResolvedConfig &
-  HttpAuthSchemeResolvedConfig;
+  EndpointResolvedConfig<EndpointParameters> &
+  HttpAuthSchemeResolvedConfig &
+  ClientResolvedEndpointParameters;
 /**
  * @public
  *
@@ -249,15 +257,16 @@ export class RpcV2ProtocolClient extends __Client<
     let _config_0 = __getRuntimeConfig(configuration || {});
     super(_config_0 as any);
     this.initConfig = _config_0;
-    let _config_1 = resolveCustomEndpointsConfig(_config_0);
+    let _config_1 = resolveClientEndpointParameters(_config_0);
     let _config_2 = resolveRetryConfig(_config_1);
-    let _config_3 = resolveHttpAuthSchemeConfig(_config_2);
-    let _config_4 = resolveRuntimeExtensions(_config_3, configuration?.extensions || []);
-    this.config = _config_4;
+    let _config_3 = resolveEndpointConfig(_config_2);
+    let _config_4 = resolveHttpAuthSchemeConfig(_config_3);
+    let _config_5 = resolveRuntimeExtensions(_config_4, configuration?.extensions || []);
+    this.config = _config_5;
     this.middlewareStack.use(getRetryPlugin(this.config));
     this.middlewareStack.use(getContentLengthPlugin(this.config));
     this.middlewareStack.use(
-      getHttpAuthSchemePlugin(this.config, {
+      getHttpAuthSchemeEndpointRuleSetPlugin(this.config, {
         httpAuthSchemeParametersProvider: defaultRpcV2ProtocolHttpAuthSchemeParametersProvider,
         identityProviderConfigProvider: async (config: RpcV2ProtocolClientResolvedConfig) =>
           new DefaultIdentityProviderConfig({}),

private/smithy-rpcv2-cbor/src/commands/EmptyInputOutputCommand.ts

@@ -1,7 +1,9 @@
 // smithy-typescript generated code
 import { RpcV2ProtocolClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RpcV2ProtocolClient";
+import { commonParams } from "../endpoint/EndpointParameters";
 import { EmptyStructure } from "../models/models_0";
 import { de_EmptyInputOutputCommand, se_EmptyInputOutputCommand } from "../protocols/Rpcv2cbor";
+import { getEndpointPlugin } from "@smithy/middleware-endpoint";
 import { getSerdePlugin } from "@smithy/middleware-serde";
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
@@ -59,8 +61,12 @@ export class EmptyInputOutputCommand extends $Command
     ServiceInputTypes,
     ServiceOutputTypes
   >()
+  .ep(commonParams)
   .m(function (this: any, Command: any, cs: any, config: RpcV2ProtocolClientResolvedConfig, o: any) {
-    return [getSerdePlugin(config, this.serialize, this.deserialize)];
+    return [
+      getSerdePlugin(config, this.serialize, this.deserialize),
+      getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
+    ];
   })
   .s("RpcV2Protocol", "EmptyInputOutput", {})
   .n("RpcV2ProtocolClient", "EmptyInputOutputCommand")

private/smithy-rpcv2-cbor/src/commands/Float16Command.ts

@@ -1,7 +1,9 @@
 // smithy-typescript generated code
 import { RpcV2ProtocolClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RpcV2ProtocolClient";
+import { commonParams } from "../endpoint/EndpointParameters";
 import { Float16Output } from "../models/models_0";
 import { de_Float16Command, se_Float16Command } from "../protocols/Rpcv2cbor";
+import { getEndpointPlugin } from "@smithy/middleware-endpoint";
 import { getSerdePlugin } from "@smithy/middleware-serde";
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
@@ -61,8 +63,12 @@ export class Float16Command extends $Command
     ServiceInputTypes,
     ServiceOutputTypes
   >()
+  .ep(commonParams)
   .m(function (this: any, Command: any, cs: any, config: RpcV2ProtocolClientResolvedConfig, o: any) {
-    return [getSerdePlugin(config, this.serialize, this.deserialize)];
+    return [
+      getSerdePlugin(config, this.serialize, this.deserialize),
+      getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
+    ];
   })
   .s("RpcV2Protocol", "Float16", {})
   .n("RpcV2ProtocolClient", "Float16Command")

private/smithy-rpcv2-cbor/src/commands/FractionalSecondsCommand.ts

@@ -1,7 +1,9 @@
 // smithy-typescript generated code
 import { RpcV2ProtocolClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RpcV2ProtocolClient";
+import { commonParams } from "../endpoint/EndpointParameters";
 import { FractionalSecondsOutput } from "../models/models_0";
 import { de_FractionalSecondsCommand, se_FractionalSecondsCommand } from "../protocols/Rpcv2cbor";
+import { getEndpointPlugin } from "@smithy/middleware-endpoint";
 import { getSerdePlugin } from "@smithy/middleware-serde";
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
@@ -61,8 +63,12 @@ export class FractionalSecondsCommand extends $Command
     ServiceInputTypes,
     ServiceOutputTypes
   >()
+  .ep(commonParams)
   .m(function (this: any, Command: any, cs: any, config: RpcV2ProtocolClientResolvedConfig, o: any) {
-    return [getSerdePlugin(config, this.serialize, this.deserialize)];
+    return [
+      getSerdePlugin(config, this.serialize, this.deserialize),
+      getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
+    ];
   })
   .s("RpcV2Protocol", "FractionalSeconds", {})
   .n("RpcV2ProtocolClient", "FractionalSecondsCommand")

private/smithy-rpcv2-cbor/src/commands/GreetingWithErrorsCommand.ts

@@ -1,7 +1,9 @@
 // smithy-typescript generated code
 import { RpcV2ProtocolClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RpcV2ProtocolClient";
+import { commonParams } from "../endpoint/EndpointParameters";
 import { GreetingWithErrorsOutput } from "../models/models_0";
 import { de_GreetingWithErrorsCommand, se_GreetingWithErrorsCommand } from "../protocols/Rpcv2cbor";
+import { getEndpointPlugin } from "@smithy/middleware-endpoint";
 import { getSerdePlugin } from "@smithy/middleware-serde";
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
@@ -74,8 +76,12 @@ export class GreetingWithErrorsCommand extends $Command
     ServiceInputTypes,
     ServiceOutputTypes
   >()
+  .ep(commonParams)
   .m(function (this: any, Command: any, cs: any, config: RpcV2ProtocolClientResolvedConfig, o: any) {
-    return [getSerdePlugin(config, this.serialize, this.deserialize)];
+    return [
+      getSerdePlugin(config, this.serialize, this.deserialize),
+      getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
+    ];
   })
   .s("RpcV2Protocol", "GreetingWithErrors", {})
   .n("RpcV2ProtocolClient", "GreetingWithErrorsCommand")