@aws-sdk/types 3.54.1 → 3.55.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.55.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.54.1...v3.55.0) (2022-03-21)
+
+
+### Bug Fixes
+
+* **types:** remove [@internal](https://github.com/internal) jsdoc tag from profile types ([#3452](https://github.com/aws/aws-sdk-js-v3/issues/3452)) ([2d7c151](https://github.com/aws/aws-sdk-js-v3/commit/2d7c151bb6d9ccfdd1eb3bd8b007e4ebcdd5daa3))
+
+
+### Features
+
+* **property-provider:** memoize() supports force refresh ([#3413](https://github.com/aws/aws-sdk-js-v3/issues/3413)) ([a79f962](https://github.com/aws/aws-sdk-js-v3/commit/a79f962873ff11a3d6f98199224155bd2ddc0b1e))
+
+
+
+
+
 ## [3.54.1](https://github.com/aws/aws-sdk-js-v3/compare/v3.54.0...v3.54.1) (2022-03-15)
 
 **Note:** Version bump only for package @aws-sdk/types

package/dist-types/profile.d.ts

@@ -1,18 +1,9 @@
-/**
- * @internal
- */
 export interface Profile {
     [key: string]: string | undefined;
 }
-/**
- * @internal
- */
 export interface ParsedIniData {
     [key: string]: Profile;
 }
-/**
- * @internal
- */
 export interface SharedConfigFiles {
     credentialsFile: ParsedIniData;
     configFile: ParsedIniData;

package/dist-types/ts3.4/profile.d.ts

@@ -1,12 +1,9 @@
-
 export interface Profile {
     [key: string]: string | undefined;
 }
-
 export interface ParsedIniData {
     [key: string]: Profile;
 }
-
 export interface SharedConfigFiles {
     credentialsFile: ParsedIniData;
     configFile: ParsedIniData;

package/dist-types/ts3.4/util.d.ts

@@ -14,6 +14,12 @@ export interface Provider<T> {
     (): Promise<T>;
 }
 
+export interface MemoizedProvider<T> {
+    (options?: {
+        forceRefresh?: boolean;
+    }): Promise<T>;
+}
+
 export interface BodyLengthCalculator {
     (body: any): number | undefined;
 }

package/dist-types/util.d.ts

@@ -33,6 +33,25 @@ export interface Decoder {
 export interface Provider<T> {
     (): Promise<T>;
 }
+/**
+ * A function that, when invoked, returns a promise that will be fulfilled with
+ * a value of type T. It memoizes the result from the previous invocation
+ * instead of calling the underlying resources every time.
+ *
+ * You can force the provider to refresh the memoized value by invoke the
+ * function with optional parameter hash with `forceRefresh` boolean key and
+ * value `true`.
+ *
+ * @example A function that reads credentials from IMDS service that could
+ * return expired credentials. The SDK will keep using the expired credentials
+ * until an unretryable service error requiring a force refresh of the
+ * credentials.
+ */
+export interface MemoizedProvider<T> {
+    (options?: {
+        forceRefresh?: boolean;
+    }): Promise<T>;
+}
 /**
  * A function that, given a request body, determines the
  * length of the body. This is used to determine the Content-Length

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/types",
-  "version": "3.54.1",
+  "version": "3.55.0",
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
   "types": "./dist-types/index.d.ts",
@@ -44,6 +44,6 @@
     "downlevel-dts": "0.7.0",
     "rimraf": "3.0.2",
     "typedoc": "0.19.2",
-    "typescript": "~4.3.5"
+    "typescript": "~4.6.2"
   }
 }