@aws-sdk/types 3.110.0 → 3.127.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.127.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.126.0...v3.127.0) (2022-07-11)
+
+
+### Features
+
+* **types:** add types to sdk stream utility mixin ([#3779](https://github.com/aws/aws-sdk-js-v3/issues/3779)) ([f311cab](https://github.com/aws/aws-sdk-js-v3/commit/f311cab406a16274dc2487dfe55c36b45a5811f5))
+
+
+
+
+
 # [3.110.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.109.0...v3.110.0) (2022-06-14)
 
 **Note:** Version bump only for package @aws-sdk/types

package/dist-types/eventStream.d.ts

@@ -59,9 +59,25 @@ export interface Int64 {
 export interface EventStreamSerdeContext {
     eventStreamMarshaller: EventStreamMarshaller;
 }
-export interface EventStreamMarshaller {
-    deserialize: (body: any, deserializer: (input: Record<string, Message>) => any) => AsyncIterable<any>;
-    serialize: (input: AsyncIterable<any>, serializer: (event: any) => Message) => any;
+/**
+ * A function which deserializes binary event stream message into modeled shape.
+ */
+export interface EventStreamMarshallerDeserFn<StreamType> {
+    <T>(body: StreamType, deserializer: (input: Record<string, Message>) => Promise<T>): AsyncIterable<T>;
+}
+/**
+ * A function that serializes modeled shape into binary stream message.
+ */
+export interface EventStreamMarshallerSerFn<StreamType> {
+    <T>(input: AsyncIterable<T>, serializer: (event: T) => Message): StreamType;
+}
+/**
+ * An interface which provides functions for serializing and deserializing binary event stream
+ * to/from corresponsing modeled shape.
+ */
+export interface EventStreamMarshaller<StreamType = any> {
+    deserialize: EventStreamMarshallerDeserFn<StreamType>;
+    serialize: EventStreamMarshallerSerFn<StreamType>;
 }
 export interface EventStreamRequestSigner {
     sign(request: HttpRequest): Promise<HttpRequest>;

package/dist-types/serde.d.ts

@@ -47,3 +47,18 @@ export interface ResponseDeserializer<OutputType, ResponseType = any, Context =
      */
     (output: ResponseType, context: Context): Promise<OutputType>;
 }
+/**
+ * The interface contains mix-in utility functions to transfer the runtime-specific
+ * stream implementation to specified format. Each stream can ONLY be transformed
+ * once.
+ */
+export interface SdkStreamMixin {
+    transformToByteArray: () => Promise<Uint8Array>;
+    transformToString: (encoding?: string) => Promise<string>;
+    transformToWebStream: () => ReadableStream;
+}
+/**
+ * The type describing a runtime-specific stream implementation with mix-in
+ * utility functions.
+ */
+export declare type SdkStream<BaseStream> = BaseStream & SdkStreamMixin;

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

@@ -53,9 +53,18 @@ export interface Int64 {
 export interface EventStreamSerdeContext {
     eventStreamMarshaller: EventStreamMarshaller;
 }
-export interface EventStreamMarshaller {
-    deserialize: (body: any, deserializer: (input: Record<string, Message>) => any) => AsyncIterable<any>;
-    serialize: (input: AsyncIterable<any>, serializer: (event: any) => Message) => any;
+
+export interface EventStreamMarshallerDeserFn<StreamType> {
+    <T>(body: StreamType, deserializer: (input: Record<string, Message>) => Promise<T>): AsyncIterable<T>;
+}
+
+export interface EventStreamMarshallerSerFn<StreamType> {
+    <T>(input: AsyncIterable<T>, serializer: (event: T) => Message): StreamType;
+}
+
+export interface EventStreamMarshaller<StreamType = any> {
+    deserialize: EventStreamMarshallerDeserFn<StreamType>;
+    serialize: EventStreamMarshallerSerFn<StreamType>;
 }
 export interface EventStreamRequestSigner {
     sign(request: HttpRequest): Promise<HttpRequest>;

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

@@ -27,3 +27,11 @@ export interface ResponseDeserializer<OutputType, ResponseType = any, Context =
     
     (output: ResponseType, context: Context): Promise<OutputType>;
 }
+
+export interface SdkStreamMixin {
+    transformToByteArray: () => Promise<Uint8Array>;
+    transformToString: (encoding?: string) => Promise<string>;
+    transformToWebStream: () => ReadableStream;
+}
+
+export declare type SdkStream<BaseStream> = BaseStream & SdkStreamMixin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/types",
-  "version": "3.110.0",
+  "version": "3.127.0",
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
   "types": "./dist-types/index.d.ts",