feat(credential-providers): rename types

Author: kuhe

packages/credential-provider-cognito-identity/src/fromCognitoIdentity.ts

@@ -1,4 +1,4 @@
-import type { AwsIdentityProperties, CredentialProviderOptions, RegionalIdentityProvider } from "@aws-sdk/types";
+import type { AwsIdentityProperties, CredentialProviderOptions, RuntimeConfigIdentityProvider } from "@aws-sdk/types";
 import { CredentialsProviderError } from "@smithy/property-provider";
 import type { AwsCredentialIdentity, Logger } from "@smithy/types";
 
@@ -18,7 +18,7 @@ export interface CognitoIdentityCredentials extends AwsCredentialIdentity {
 /**
  * @internal
  */
-export type CognitoIdentityCredentialProvider = RegionalIdentityProvider<CognitoIdentityCredentials>;
+export type CognitoIdentityCredentialProvider = RuntimeConfigIdentityProvider<CognitoIdentityCredentials>;
 
 /**
  * @internal

packages/credential-provider-ini/src/fromIni.ts

@@ -1,6 +1,6 @@
 import type { AssumeRoleWithWebIdentityParams } from "@aws-sdk/credential-provider-web-identity";
 import type { CredentialProviderOptions } from "@aws-sdk/types";
-import type { RegionalAwsCredentialIdentityProvider } from "@aws-sdk/types";
+import type { RuntimeConfigAwsCredentialIdentityProvider } from "@aws-sdk/types";
 import { getProfileName, parseKnownFiles, SourceProfileInit } from "@smithy/shared-ini-file-loader";
 import type { AwsCredentialIdentity, Pluggable } from "@smithy/types";
 
@@ -56,7 +56,7 @@ export interface FromIniInit extends SourceProfileInit, CredentialProviderOption
  * role assumption and multi-factor authentication.
  */
 export const fromIni =
-  (_init: FromIniInit = {}): RegionalAwsCredentialIdentityProvider =>
+  (_init: FromIniInit = {}): RuntimeConfigAwsCredentialIdentityProvider =>
   async ({ callerClientConfig } = {}) => {
     const init: FromIniInit = {
       ..._init,

packages/credential-provider-web-identity/src/fromWebToken.ts

@@ -1,7 +1,7 @@
 import type {
   AwsIdentityProperties,
   CredentialProviderOptions,
-  RegionalAwsCredentialIdentityProvider,
+  RuntimeConfigAwsCredentialIdentityProvider,
 } from "@aws-sdk/types";
 import type { AwsCredentialIdentity, Pluggable } from "@smithy/types";
 
@@ -155,7 +155,7 @@ export interface FromWebTokenInit
  * @internal
  */
 export const fromWebToken =
-  (init: FromWebTokenInit): RegionalAwsCredentialIdentityProvider =>
+  (init: FromWebTokenInit): RuntimeConfigAwsCredentialIdentityProvider =>
   async (awsIdentityProperties?: AwsIdentityProperties) => {
     init.logger?.debug("@aws-sdk/credential-provider-web-identity - fromWebToken");
     const { roleArn, roleSessionName, webIdentityToken, providerId, policyArns, policy, durationSeconds } = init;

packages/credential-providers/src/createCredentialChain.spec.ts

@@ -1,4 +1,4 @@
-import { RegionalAwsCredentialIdentityProvider } from "@aws-sdk/types";
+import { RuntimeConfigAwsCredentialIdentityProvider } from "@aws-sdk/types";
 import { ProviderError } from "@smithy/property-provider";
 import { AwsCredentialIdentity, AwsCredentialIdentityProvider } from "@smithy/types";
 import { describe, expect, test as it } from "vitest";
@@ -82,7 +82,7 @@ describe(createCredentialChain.name, () => {
   });
 
   it("is compatible with contextual-region-aware credential providers", async () => {
-    const provider: RegionalAwsCredentialIdentityProvider = async ({ callerClientConfig } = {}) => {
+    const provider: RuntimeConfigAwsCredentialIdentityProvider = async ({ callerClientConfig } = {}) => {
       return {
         accessKeyId: "",
         secretAccessKey: "",

packages/credential-providers/src/createCredentialChain.ts

@@ -1,7 +1,7 @@
 import type {
   AwsIdentityProperties,
-  RegionalAwsCredentialIdentityProvider,
-  RegionalIdentityProvider,
+  RuntimeConfigAwsCredentialIdentityProvider,
+  RuntimeConfigIdentityProvider,
 } from "@aws-sdk/types";
 import { ProviderError } from "@smithy/property-provider";
 import type { AwsCredentialIdentityProvider } from "@smithy/types";
@@ -57,8 +57,8 @@ type Mutable<Type> = {
  * providers in sequence until one succeeds or all fail.
  */
 export const createCredentialChain = (
-  ...credentialProviders: RegionalAwsCredentialIdentityProvider[]
-): RegionalAwsCredentialIdentityProvider & CustomCredentialChainOptions => {
+  ...credentialProviders: RuntimeConfigAwsCredentialIdentityProvider[]
+): RuntimeConfigAwsCredentialIdentityProvider & CustomCredentialChainOptions => {
   let expireAfter = -1;
   const baseFunction = async (awsIdentityProperties?: AwsIdentityProperties) => {
     const credentials = await propertyProviderChain(...credentialProviders)(awsIdentityProperties);
@@ -85,7 +85,7 @@ export const createCredentialChain = (
  * @internal
  */
 export const propertyProviderChain =
-  <T>(...providers: Array<RegionalIdentityProvider<T>>): RegionalIdentityProvider<T> =>
+  <T>(...providers: Array<RuntimeConfigIdentityProvider<T>>): RuntimeConfigIdentityProvider<T> =>
   async (awsIdentityProperties?: AwsIdentityProperties) => {
     if (providers.length === 0) {
       throw new ProviderError("No providers in chain");

packages/credential-providers/src/fromIni.ts

@@ -1,5 +1,5 @@
 import { fromIni as _fromIni, FromIniInit } from "@aws-sdk/credential-provider-ini";
-import type { RegionalAwsCredentialIdentityProvider } from "@aws-sdk/types";
+import type { RuntimeConfigAwsCredentialIdentityProvider } from "@aws-sdk/types";
 
 /**
  * Creates a credential provider function that reads from a shared credentials file at `~/.aws/credentials` and a
@@ -40,7 +40,7 @@ import type { RegionalAwsCredentialIdentityProvider } from "@aws-sdk/types";
  * });
  * ```
  */
-export const fromIni = (init: FromIniInit = {}): RegionalAwsCredentialIdentityProvider =>
+export const fromIni = (init: FromIniInit = {}): RuntimeConfigAwsCredentialIdentityProvider =>
   _fromIni({
     ...init,
   });

packages/middleware-signing/src/awsAuthConfiguration.ts

@@ -1,4 +1,4 @@
-import type { AwsCredentialIdentityProvider, RegionalAwsCredentialIdentityProvider } from "@aws-sdk/types";
+import type { AwsCredentialIdentityProvider, RuntimeConfigAwsCredentialIdentityProvider } from "@aws-sdk/types";
 import { memoize } from "@smithy/property-provider";
 import { SignatureV4, SignatureV4CryptoInit, SignatureV4Init } from "@smithy/signature-v4";
 import {
@@ -293,7 +293,7 @@ export const resolveSigV4AuthConfig = <T>(
  * @deprecated only used in legacy auth.
  */
 const normalizeCredentialProvider = (
-  credentials: AwsCredentialIdentity | Provider<AwsCredentialIdentity> | RegionalAwsCredentialIdentityProvider
+  credentials: AwsCredentialIdentity | Provider<AwsCredentialIdentity> | RuntimeConfigAwsCredentialIdentityProvider
 ): MemoizedProvider<AwsCredentialIdentity> => {
   if (typeof credentials === "function") {
     return memoize(
@@ -315,7 +315,7 @@ const normalizeCredentialProvider = (
  * a binding to the config itself.
  */
 const createConfigBoundCredentialProvider = (input: {
-  credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider | RegionalAwsCredentialIdentityProvider;
+  credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider | RuntimeConfigAwsCredentialIdentityProvider;
   credentialDefaultProvider: PreviouslyResolved["credentialDefaultProvider"];
   region: PreviouslyResolved["region"];
 }): AwsCredentialIdentityProvider => {
@@ -327,7 +327,7 @@ const createConfigBoundCredentialProvider = (input: {
         })
       );
   const normalizedCreds = async () =>
-    (normalizedCredentialsProvider as RegionalAwsCredentialIdentityProvider)({
+    (normalizedCredentialsProvider as RuntimeConfigAwsCredentialIdentityProvider)({
       callerClientConfig: {
         region: normalizeProvider(input.region),
       },

packages/token-providers/src/fromSso.ts

@@ -1,7 +1,7 @@
 import {
   AwsIdentityProperties,
   CredentialProviderOptions,
-  RegionalIdentityProvider,
+  RuntimeConfigIdentityProvider,
   TokenIdentity,
 } from "@aws-sdk/types";
 import { TokenProviderError } from "@smithy/property-provider";
@@ -36,7 +36,7 @@ export interface FromSsoInit extends SourceProfileInit, CredentialProviderOption
  * Creates a token provider that will read from SSO token cache or ssoOidc.createToken() call.
  */
 export const fromSso =
-  (_init: FromSsoInit = {}): RegionalIdentityProvider<TokenIdentity> =>
+  (_init: FromSsoInit = {}): RuntimeConfigIdentityProvider<TokenIdentity> =>
   async (awsIdentityProperties?: AwsIdentityProperties) => {
     const init: FromSsoInit = {
       ..._init,

packages/types/src/identity/AwsCredentialIdentity.ts

@@ -17,23 +17,25 @@ export interface AwsIdentityProperties {
  * @public
  *
  * Variation of {@link IdentityProvider} which accepts a contextual
- * client configuration that includes an AWS region.
+ * client configuration that includes an AWS region and potentially other
+ * configurable fields.
  *
- * Used to link a credential provider to a client region if it is being called
+ * Used to link a credential provider to a client if it is being called
  * in the context of a client.
  */
-export type RegionalIdentityProvider<T> = (awsIdentityProperties?: AwsIdentityProperties) => Promise<T>;
+export type RuntimeConfigIdentityProvider<T> = (awsIdentityProperties?: AwsIdentityProperties) => Promise<T>;
 
 /**
  * @public
  *
  * Variation of {@link AwsCredentialIdentityProvider} which accepts a contextual
- * client configuration that includes an AWS region.
+ * client configuration that includes an AWS region and potentially other
+ * configurable fields.
  *
- * Used to link a credential provider to a client region if it is being called
+ * Used to link a credential provider to a client if it is being called
  * in the context of a client.
  */
-export type RegionalAwsCredentialIdentityProvider = RegionalIdentityProvider<AwsCredentialIdentity>;
+export type RuntimeConfigAwsCredentialIdentityProvider = RuntimeConfigIdentityProvider<AwsCredentialIdentity>;
 
 /**
  * @public