Merge pull request #35 from jeskew/feature/marshaller-unmarshaller-types

Add types for marshallers and unmarshallers

Author: jeskew

packages/types/marshaller.ts

@@ -0,0 +1,28 @@
+import {Member, OperationModel} from "./protocol";
+import {HttpRequest} from "./http";
+
+export interface BodySerializer<SerializedType = string> {
+    /**
+     * Converts the provided `input` into the serialized format described in the
+     * provided `shape`.
+     *
+     * @param shape The serialization model shape to which the input should be
+     *              converted
+     * @param input The value to convert
+     *
+     * @throws if a node in the input cannot be converted into the type
+     *          specified by the serialization model
+     */
+    build(shape: Member, input: any): SerializedType;
+}
+
+export interface RequestSerializer<StreamType = Uint8Array> {
+    /**
+     * Converts the provided `input` into an HTTP request
+     *
+     * @param operation The operation to be executed via the returned HTTP
+     *                  request.
+     * @param input     The user input to serialize.
+     */
+    serialize(operation: OperationModel, input: any): HttpRequest<StreamType>;
+}

packages/types/unmarshaller.ts

@@ -0,0 +1,38 @@
+import {Member, OperationModel} from "./protocol";
+import {HttpResponse} from "./http";
+
+export interface BodyParser<SerializedType = string> {
+    /**
+     * Convert the provided input into the shape described in the supplied
+     * serialization model.
+     *
+     * @param shape A serialization model describing the expected shape of the
+     *              value supplied as `input`.
+     * @param input The value to parse
+     */
+    parse<OutputType>(
+        shape: Member,
+        input: SerializedType
+    ): OutputType;
+}
+
+export interface ResponseParser<StreamType = Uint8Array> {
+    /**
+     * Converts the output of an operation into JavaScript types.
+     *
+     * @param operation The operation model describing the structure of the HTTP
+     *                  response received
+     * @param input     The HTTP response received from the service
+     */
+    parse<OutputType>(
+        operation: OperationModel,
+        input: HttpResponse<StreamType>
+    ): Promise<OutputType>;
+}
+
+/**
+ * A function that converts a stream into an array of bytes.
+ */
+export interface StreamCollector<StreamType> {
+    (stream: StreamType): Promise<Uint8Array>;
+}