@smithy/eventstream-codec 4.2.11 → 4.2.13

package/README.md

@@ -2,3 +2,16 @@
 
 [![NPM version](https://img.shields.io/npm/v/@smithy/eventstream-codec/latest.svg)](https://www.npmjs.com/package/@smithy/eventstream-codec)
 [![NPM downloads](https://img.shields.io/npm/dm/@smithy/eventstream-codec.svg)](https://www.npmjs.com/package/@smithy/eventstream-codec)
+
+### :warning: Internal API :warning:
+
+> This is an internal package.
+> That means this is used as a dependency for other, public packages, but
+> should not be taken directly as a dependency in your application's `package.json`.
+
+> If you are updating the version of this package, for example to bring in a
+> bug-fix, you should do so by updating your application lockfile with
+> e.g. `npm up @scope/package` or equivalent command in another
+> package manager, rather than taking a direct dependency.
+
+---

package/dist-cjs/index.js

@@ -206,6 +206,19 @@ class HeaderMarshaller {
         return out;
     }
 }
+var HEADER_VALUE_TYPE;
+(function (HEADER_VALUE_TYPE) {
+    HEADER_VALUE_TYPE[HEADER_VALUE_TYPE["boolTrue"] = 0] = "boolTrue";
+    HEADER_VALUE_TYPE[HEADER_VALUE_TYPE["boolFalse"] = 1] = "boolFalse";
+    HEADER_VALUE_TYPE[HEADER_VALUE_TYPE["byte"] = 2] = "byte";
+    HEADER_VALUE_TYPE[HEADER_VALUE_TYPE["short"] = 3] = "short";
+    HEADER_VALUE_TYPE[HEADER_VALUE_TYPE["integer"] = 4] = "integer";
+    HEADER_VALUE_TYPE[HEADER_VALUE_TYPE["long"] = 5] = "long";
+    HEADER_VALUE_TYPE[HEADER_VALUE_TYPE["byteArray"] = 6] = "byteArray";
+    HEADER_VALUE_TYPE[HEADER_VALUE_TYPE["string"] = 7] = "string";
+    HEADER_VALUE_TYPE[HEADER_VALUE_TYPE["timestamp"] = 8] = "timestamp";
+    HEADER_VALUE_TYPE[HEADER_VALUE_TYPE["uuid"] = 9] = "uuid";
+})(HEADER_VALUE_TYPE || (HEADER_VALUE_TYPE = {}));
 const BOOLEAN_TAG = "boolean";
 const BYTE_TAG = "byte";
 const SHORT_TAG = "short";

package/package.json

@@ -1,16 +1,15 @@
 {
   "name": "@smithy/eventstream-codec",
-  "version": "4.2.11",
+  "version": "4.2.13",
   "scripts": {
-    "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types && yarn build:types:downlevel'",
-    "build:cjs": "node ../../scripts/inline eventstream-codec",
-    "build:es": "yarn g:tsc -p tsconfig.es.json",
+    "build": "concurrently 'yarn:build:types' 'yarn:build:es:cjs'",
+    "build:es:cjs": "yarn g:tsc -p tsconfig.es.json && node ../../scripts/inline eventstream-codec",
     "build:types": "yarn g:tsc -p tsconfig.types.json",
     "build:types:downlevel": "premove dist-types/ts3.4 && downlevel-dts dist-types dist-types/ts3.4",
-    "stage-release": "premove .release && yarn pack && mkdir ./.release && tar zxvf ./package.tgz --directory ./.release && rm ./package.tgz",
     "clean": "premove dist-cjs dist-es dist-types tsconfig.cjs.tsbuildinfo tsconfig.es.tsbuildinfo tsconfig.types.tsbuildinfo",
-    "lint": "eslint -c ../../.eslintrc.js \"src/**/*.ts\"",
     "format": "prettier --config ../../prettier.config.js --ignore-path ../../.prettierignore --write \"**/*.{ts,md,json}\"",
+    "lint": "eslint -c ../../.eslintrc.js \"src/**/*.ts\"",
+    "stage-release": "premove .release && yarn pack && mkdir ./.release && tar zxvf ./package.tgz --directory ./.release && rm ./package.tgz",
     "test": "yarn g:vitest run",
     "test:watch": "yarn g:vitest watch"
   },
@@ -25,7 +24,7 @@
   "sideEffects": false,
   "dependencies": {
     "@aws-crypto/crc32": "5.2.0",
-    "@smithy/types": "^4.13.0",
+    "@smithy/types": "^4.14.0",
     "@smithy/util-hex-encoding": "^4.2.2",
     "tslib": "^2.6.2"
   },

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

@@ -1,31 +0,0 @@
-import { AvailableMessage, AvailableMessages, Message, MessageDecoder, MessageEncoder, MessageHeaders } from "@smithy/types";
-import { Decoder, Encoder } from "@smithy/types";
-/**
- * A Codec that can convert binary-packed event stream messages into
- * JavaScript objects and back again into their binary format.
- */
-export declare class EventStreamCodec implements MessageEncoder, MessageDecoder {
-    private readonly headerMarshaller;
-    private messageBuffer;
-    private isEndOfStream;
-    constructor(toUtf8: Encoder, fromUtf8: Decoder);
-    feed(message: ArrayBufferView): void;
-    endOfStream(): void;
-    getMessage(): AvailableMessage;
-    getAvailableMessages(): AvailableMessages;
-    /**
-     * Convert a structured JavaScript object with tagged headers into a binary
-     * event stream message.
-     */
-    encode({ headers: rawHeaders, body }: Message): Uint8Array;
-    /**
-     * Convert a binary event stream message into a JavaScript object with an
-     * opaque, binary body and tagged, parsed headers.
-     */
-    decode(message: ArrayBufferView): Message;
-    /**
-     * Convert a structured JavaScript object with tagged headers into a binary
-     * event stream message header.
-     */
-    formatHeaders(rawHeaders: MessageHeaders): Uint8Array;
-}

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

@@ -1,12 +0,0 @@
-import { Decoder, Encoder, MessageHeaders } from "@smithy/types";
-/**
- * @internal
- */
-export declare class HeaderMarshaller {
-    private readonly toUtf8;
-    private readonly fromUtf8;
-    constructor(toUtf8: Encoder, fromUtf8: Decoder);
-    format(headers: MessageHeaders): Uint8Array;
-    private formatHeaderValue;
-    parse(headers: DataView): MessageHeaders;
-}

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

@@ -1,20 +0,0 @@
-import { Int64 as IInt64 } from "@smithy/types";
-export interface Int64 extends IInt64 {
-}
-/**
- * A lossless representation of a signed, 64-bit integer. Instances of this
- * class may be used in arithmetic expressions as if they were numeric
- * primitives, but the binary representation will be preserved unchanged as the
- * `bytes` property of the object. The bytes should be encoded as big-endian,
- * two's complement integers.
- */
-export declare class Int64 {
-    readonly bytes: Uint8Array;
-    constructor(bytes: Uint8Array);
-    static fromNumber(number: number): Int64;
-    /**
-     * Called implicitly by infix arithmetic operators.
-     */
-    valueOf(): number;
-    toString(): string;
-}

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

@@ -1,26 +0,0 @@
-import { Int64 } from "./Int64";
-/**
- * An event stream message. The headers and body properties will always be
- * defined, with empty headers represented as an object with no keys and an
- * empty body represented as a zero-length Uint8Array.
- */
-export interface Message {
-    headers: MessageHeaders;
-    body: Uint8Array;
-}
-export type MessageHeaders = Record<string, MessageHeaderValue>;
-type HeaderValue<K extends string, V> = {
-    type: K;
-    value: V;
-};
-export type BooleanHeaderValue = HeaderValue<"boolean", boolean>;
-export type ByteHeaderValue = HeaderValue<"byte", number>;
-export type ShortHeaderValue = HeaderValue<"short", number>;
-export type IntegerHeaderValue = HeaderValue<"integer", number>;
-export type LongHeaderValue = HeaderValue<"long", Int64>;
-export type BinaryHeaderValue = HeaderValue<"binary", Uint8Array>;
-export type StringHeaderValue = HeaderValue<"string", string>;
-export type TimestampHeaderValue = HeaderValue<"timestamp", Date>;
-export type UuidHeaderValue = HeaderValue<"uuid", string>;
-export type MessageHeaderValue = BooleanHeaderValue | ByteHeaderValue | ShortHeaderValue | IntegerHeaderValue | LongHeaderValue | BinaryHeaderValue | StringHeaderValue | TimestampHeaderValue | UuidHeaderValue;
-export {};

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

@@ -1,17 +0,0 @@
-import { Message, MessageDecoder } from "@smithy/types";
-/**
- * @internal
- */
-export interface MessageDecoderStreamOptions {
-    inputStream: AsyncIterable<Uint8Array>;
-    decoder: MessageDecoder;
-}
-/**
- * @internal
- */
-export declare class MessageDecoderStream implements AsyncIterable<Message> {
-    private readonly options;
-    constructor(options: MessageDecoderStreamOptions);
-    [Symbol.asyncIterator](): AsyncIterator<Message>;
-    private asyncIterator;
-}

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

@@ -1,18 +0,0 @@
-import { Message, MessageEncoder } from "@smithy/types";
-/**
- * @internal
- */
-export interface MessageEncoderStreamOptions {
-    messageStream: AsyncIterable<Message>;
-    encoder: MessageEncoder;
-    includeEndFrame?: boolean;
-}
-/**
- * @internal
- */
-export declare class MessageEncoderStream implements AsyncIterable<Uint8Array> {
-    private readonly options;
-    constructor(options: MessageEncoderStreamOptions);
-    [Symbol.asyncIterator](): AsyncIterator<Uint8Array>;
-    private asyncIterator;
-}

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

@@ -1,17 +0,0 @@
-import { Message } from "@smithy/types";
-/**
- * @internal
- */
-export interface SmithyMessageDecoderStreamOptions<T> {
-    readonly messageStream: AsyncIterable<Message>;
-    readonly deserializer: (input: Message) => Promise<T | undefined>;
-}
-/**
- * @internal
- */
-export declare class SmithyMessageDecoderStream<T> implements AsyncIterable<T> {
-    private readonly options;
-    constructor(options: SmithyMessageDecoderStreamOptions<T>);
-    [Symbol.asyncIterator](): AsyncIterator<T>;
-    private asyncIterator;
-}

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

@@ -1,17 +0,0 @@
-import { Message } from "@smithy/types";
-/**
- * @internal
- */
-export interface SmithyMessageEncoderStreamOptions<T> {
-    inputStream: AsyncIterable<T>;
-    serializer: (event: T) => Message;
-}
-/**
- * @internal
- */
-export declare class SmithyMessageEncoderStream<T> implements AsyncIterable<Message> {
-    private readonly options;
-    constructor(options: SmithyMessageEncoderStreamOptions<T>);
-    [Symbol.asyncIterator](): AsyncIterator<Message>;
-    private asyncIterator;
-}

package/dist-types/ts3.4/TestVectors.fixture.d.ts

@@ -1,2 +0,0 @@
-import { TestVectors } from "./vectorTypes.fixture";
-export declare const vectors: TestVectors;

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

@@ -1,8 +0,0 @@
-export * from "./EventStreamCodec";
-export * from "./HeaderMarshaller";
-export * from "./Int64";
-export * from "./Message";
-export * from "./MessageDecoderStream";
-export * from "./MessageEncoderStream";
-export * from "./SmithyMessageDecoderStream";
-export * from "./SmithyMessageEncoderStream";

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

@@ -1,11 +0,0 @@
-/**
- * @internal
- */
-export interface MessageParts {
-    headers: DataView;
-    body: Uint8Array;
-}
-/**
- * @internal
- */
-export declare function splitMessage({ byteLength, byteOffset, buffer }: ArrayBufferView): MessageParts;

package/dist-types/ts3.4/vectorTypes.fixture.d.ts

@@ -1,12 +0,0 @@
-import { Message } from "./Message";
-export interface NegativeTestVector {
-    expectation: "failure";
-    encoded: Uint8Array;
-}
-export interface PositiveTestVector {
-    expectation: "success";
-    encoded: Uint8Array;
-    decoded: Message;
-}
-export type TestVector = NegativeTestVector | PositiveTestVector;
-export type TestVectors = Record<string, TestVector>;