feat(endpoint): fixes to types

aws · Sep 20, 2022 · 3dee79e · 3dee79e
1 parent a6a8fd2
commit 3dee79e
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 14 deletions.
diff --git a/packages/middleware-endpoint/src/adaptors/getEndpointFromInstructions.ts b/packages/middleware-endpoint/src/adaptors/getEndpointFromInstructions.ts
@@ -10,12 +10,12 @@ import { EndpointParameterInstructions } from "../types";
  *
  * @private
  */
-export const getEndpointFromInstructions = async (
+export const getEndpointFromInstructions = async <T extends EndpointParameters>(
   commandInput: any,
   instructionsSupplier: Partial<{
     getEndpointParameterInstructions(): EndpointParameterInstructions;
   }>,
-  clientConfig: Partial<EndpointResolvedConfig>,
+  clientConfig: Partial<EndpointResolvedConfig<T>>,
   context?: HandlerExecutionContext
 ): Promise<EndpointV2> => {
   const endpointParams: EndpointParameters = {};
@@ -43,7 +43,7 @@ export const getEndpointFromInstructions = async (
     }
   }
 
-  const endpoint: EndpointV2 = clientConfig.endpointProvider!(endpointParams, context);
+  const endpoint: EndpointV2 = clientConfig.endpointProvider!(endpointParams as T, context);
   return endpoint;
 };
 

diff --git a/packages/middleware-endpoint/src/endpointMiddleware.ts b/packages/middleware-endpoint/src/endpointMiddleware.ts
@@ -1,6 +1,7 @@
 import { HttpRequest } from "@aws-sdk/protocol-http";
 import { parseQueryString } from "@aws-sdk/querystring-parser";
 import {
+  EndpointParameters,
   EndpointV2,
   HandlerExecutionContext,
   MetadataBearer,
@@ -17,11 +18,11 @@ import { EndpointParameterInstructions } from "./types";
 /**
  * @private
  */
-export const endpointMiddleware = ({
+export const endpointMiddleware = <T extends EndpointParameters>({
   config,
   instructions,
 }: {
-  config: EndpointResolvedConfig;
+  config: EndpointResolvedConfig<T>;
   instructions: EndpointParameterInstructions;
 }): SerializeMiddleware<any, any> => {
   return <Output extends MetadataBearer>(

diff --git a/packages/middleware-endpoint/src/getEndpointPlugin.ts b/packages/middleware-endpoint/src/getEndpointPlugin.ts
@@ -1,4 +1,4 @@
-import { Pluggable, SerializeHandlerOptions } from "@aws-sdk/types";
+import { EndpointParameters, Pluggable, SerializeHandlerOptions } from "@aws-sdk/types";
 
 import { endpointMiddleware } from "./endpointMiddleware";
 import { EndpointResolvedConfig } from "./resolveEndpointConfig";
@@ -11,13 +11,13 @@ export const endpointMiddlewareOptions: SerializeHandlerOptions = {
   override: true,
 };
 
-export const getEndpointPlugin = (
-  config: EndpointResolvedConfig,
+export const getEndpointPlugin = <T extends EndpointParameters>(
+  config: EndpointResolvedConfig<T>,
   instructions: EndpointParameterInstructions
 ): Pluggable<any, any> => ({
   applyToStack: (clientStack) => {
     clientStack.add(
-      endpointMiddleware({
+      endpointMiddleware<T>({
         config,
         instructions,
       }),

diff --git a/packages/middleware-endpoint/src/resolveEndpointConfig.ts b/packages/middleware-endpoint/src/resolveEndpointConfig.ts
@@ -13,7 +13,7 @@ export interface EndpointInputConfig<T extends EndpointParameters = EndpointPara
    * The fully qualified endpoint of the webservice. This is only required when using
    * a custom endpoint (for example, when using a local version of S3).
    */
-  endpoint?: string | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+  endpoint: string | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
 
   endpointProvider?: (params: T, context?: { logger?: Logger }) => EndpointV2;
 
@@ -50,7 +50,7 @@ export interface EndpointResolvedConfig<T extends EndpointParameters = EndpointP
    * Resolved value for input {@link EndpointsInputConfig.endpoint}
    * @deprecated Use {@link EndpointResolvedConfig.endpointProvider} instead
    */
-  endpoint?: Provider<Endpoint>;
+  endpoint: Provider<Endpoint>;
 
   endpointProvider: (params: T, context?: { logger?: Logger }) => EndpointV2;
 

diff --git a/packages/middleware-serde/src/serdePlugin.ts b/packages/middleware-serde/src/serdePlugin.ts
@@ -5,7 +5,6 @@ import {
   MetadataBearer,
   MiddlewareStack,
   Pluggable,
-  Provider,
   RequestSerializer,
   ResponseDeserializer,
   SerializeHandlerOptions,

diff --git a/packages/middleware-signing/src/middleware.ts b/packages/middleware-signing/src/middleware.ts
@@ -24,7 +24,7 @@ export const awsAuthMiddleware =
       if (!HttpRequest.isInstance(args.request)) return next(args);
 
       // TODO(identityandauth): call authScheme resolver
-      const authScheme: AuthScheme = (context.endpointV2 as EndpointV2)?.properties?.authSchemes?.[0];
+      const authScheme: AuthScheme | undefined = (context.endpointV2 as EndpointV2)?.properties?.authSchemes?.[0];
 
       const signer = await options.signer(authScheme);
 

diff --git a/packages/util-endpoints/src/types/RuleSetObject.ts b/packages/util-endpoints/src/types/RuleSetObject.ts
@@ -6,10 +6,11 @@ export type DeprecatedObject = {
 };
 
 export type ParameterObject = {
-  type: "string" | "boolean";
+  type: "String" | "Boolean";
   default?: string | boolean;
   required?: boolean;
   documentation?: string;
+  builtIn?: string;
   deprecated?: DeprecatedObject;
 };