@smithy/eventstream-serde-browser 1.0.0 → 1.0.2

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

@@ -0,0 +1,47 @@
+import { Decoder, Encoder, EventStreamMarshaller as IEventStreamMarshaller, Message } from "@smithy/types";
+/**
+ * @internal
+ */
+export interface EventStreamMarshaller extends IEventStreamMarshaller {
+}
+/**
+ * @internal
+ */
+export interface EventStreamMarshallerOptions {
+    utf8Encoder: Encoder;
+    utf8Decoder: Decoder;
+}
+/**
+ * @internal
+ *
+ * Utility class used to serialize and deserialize event streams in
+ * browsers and ReactNative.
+ *
+ * In browsers where ReadableStream API is available:
+ * * deserialize from ReadableStream to an async iterable of output structure
+ * * serialize from async iterable of input structure to ReadableStream
+ * In ReactNative where only async iterable API is available:
+ * * deserialize from async iterable of binaries to async iterable of output structure
+ * * serialize from async iterable of input structure to async iterable of binaries
+ *
+ * We use ReadableStream API in browsers because of the consistency with other
+ * streaming operations, where ReadableStream API is used to denote streaming data.
+ * Whereas in ReactNative, ReadableStream API is not available, we use async iterable
+ * for streaming data although it has lower throughput.
+ */
+export declare class EventStreamMarshaller {
+    private readonly universalMarshaller;
+    constructor({ utf8Encoder, utf8Decoder }: EventStreamMarshallerOptions);
+    deserialize<T>(body: ReadableStream<Uint8Array> | AsyncIterable<Uint8Array>, deserializer: (input: Record<string, Message>) => Promise<T>): AsyncIterable<T>;
+    /**
+     * Generate a stream that serialize events into stream of binary chunks;
+     *
+     * Caveat is that streaming request payload doesn't work on browser with native
+     * xhr or fetch handler currently because they don't support upload streaming.
+     * reference:
+     * * https://bugs.chromium.org/p/chromium/issues/detail?id=688906
+     * * https://bugzilla.mozilla.org/show_bug.cgi?id=1387483
+     *
+     */
+    serialize<T>(input: AsyncIterable<T>, serializer: (event: T) => Message): ReadableStream | AsyncIterable<Uint8Array>;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * @internal
+ */
+export * from "./EventStreamMarshaller";
+/**
+ * @internal
+ */
+export * from "./provider";
+/**
+ * @internal
+ */
+export * from "./utils";

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

@@ -0,0 +1,3 @@
+import { EventStreamSerdeProvider } from "@smithy/types";
+/** browser event stream serde utils provider */
+export declare const eventStreamSerdeProvider: EventStreamSerdeProvider;

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

@@ -0,0 +1,13 @@
+/**
+ * @internal
+ *
+ * A util function converting ReadableStream into an async iterable.
+ * Reference: https://jakearchibald.com/2017/async-iterators-and-generators/#making-streams-iterate
+ */
+export declare const readableStreamtoIterable: <T>(readableStream: ReadableStream<T>) => AsyncIterable<T>;
+/**
+ * @internal
+ *
+ * A util function converting async iterable to a ReadableStream.
+ */
+export declare const iterableToReadableStream: <T>(asyncIterable: AsyncIterable<T>) => ReadableStream<T>;

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@smithy/eventstream-serde-browser",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "scripts": {
-    "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
+    "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types && yarn build:types:downlevel'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
     "build:es": "tsc -p tsconfig.es.json",
     "build:types": "tsc -p tsconfig.types.json",
@@ -22,8 +22,8 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@smithy/eventstream-serde-universal": "workspace:^",
-    "@smithy/types": "workspace:^",
+    "@smithy/eventstream-serde-universal": "^1.0.2",
+    "@smithy/types": "^1.1.1",
     "tslib": "^2.5.0"
   },
   "engines": {
@@ -56,5 +56,8 @@
   },
   "typedoc": {
     "entryPoint": "src/index.ts"
+  },
+  "publishConfig": {
+    "directory": ".release/package"
   }
-}
+}