@smithy/types - npm Package Compare versions

Comparing version 3.7.2 to 4.0.0

dist-types/blob/blob-payload-input-types.d.ts

 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
 import { Readable } from "stream";
@@ -39,4 +40,5 @@ import type { BlobOptionalType, ReadableStreamOptionalType } from "../externals-check/browser-externals-check";
 /**
+ * @internal
  * @deprecated renamed to BlobPayloadInputTypes.
  */
 export type BlobTypes = BlobPayloadInputTypes;

dist-types/client.d.ts

@@ -50,2 +50,3 @@ import { Command } from "./command";
  * It's provided for using without importing the SmithyClient class.
+ * @internal
  */
@@ -52,0 +53,0 @@ export interface Client<Input extends object, Output extends MetadataBearer, ResolvedClientConfiguration> {

dist-types/connection/config.d.ts

@@ -0,1 +1,4 @@
+/**
+ * @public
+ */
 export interface ConnectConfiguration {
@@ -2,0 +5,0 @@ /**

dist-types/connection/manager.d.ts

 import { RequestContext } from "../transfer";
 import { ConnectConfiguration } from "./config";
+/**
+ * @public
+ */
 export interface ConnectionManagerConfiguration {
@@ -13,2 +16,5 @@ /**
 }
+/**
+ * @public
+ */
 export interface ConnectionManager<T> {
@@ -15,0 +21,0 @@ /**

dist-types/connection/pool.d.ts

@@ -0,1 +1,4 @@
+/**
+ * @public
+ */
 export interface ConnectionPool<T> {
@@ -22,4 +25,9 @@ /**
 }
+/**
+ * Unused.
+ * @internal
+ * @deprecated
+ */
 export interface CacheKey {
     destination: string;
 }

dist-types/encode.d.ts

 import { Message } from "./eventStream";
+/**
+ * @public
+ */
 export interface MessageEncoder {
     encode(message: Message): Uint8Array;
 }
+/**
+ * @public
+ */
 export interface MessageDecoder {
@@ -12,2 +18,5 @@ decode(message: ArrayBufferView): Message;
 }
+/**
+ * @public
+ */
 export interface AvailableMessage {
@@ -17,2 +26,5 @@ getMessage(): Message | undefined;
 }
+/**
+ * @public
+ */
 export interface AvailableMessages {
@@ -19,0 +31,0 @@ getMessages(): Message[];

dist-types/endpoints/EndpointRuleObject.d.ts

 import { EndpointObjectProperty } from "../endpoint";
 import { ConditionObject, Expression } from "./shared";
+/**
+ * @public
+ */
 export type EndpointObjectProperties = Record<string, EndpointObjectProperty>;
+/**
+ * @public
+ */
 export type EndpointObjectHeaders = Record<string, Expression[]>;
+/**
+ * @public
+ */
 export type EndpointObject = {
@@ -10,2 +19,5 @@ url: Expression;
 };
+/**
+ * @public
+ */
 export type EndpointRuleObject = {
@@ -12,0 +24,0 @@ type: "endpoint";

dist-types/endpoints/ErrorRuleObject.d.ts

 import { ConditionObject, Expression } from "./shared";
+/**
+ * @public
+ */
 export type ErrorRuleObject = {
@@ -3,0 +6,0 @@ type: "error";

dist-types/endpoints/RuleSetObject.d.ts

 import { RuleSetRules } from "./TreeRuleObject";
+/**
+ * @public
+ */
 export type DeprecatedObject = {
@@ -6,2 +9,5 @@ message?: string;
 };
+/**
+ * @public
+ */
 export type ParameterObject = {
@@ -15,2 +21,5 @@ type: "String" | "string" | "Boolean" | "boolean";
 };
+/**
+ * @public
+ */
 export type RuleSetObject = {
@@ -17,0 +26,0 @@ version: string;

dist-types/endpoints/shared.d.ts

 import { Logger } from "../logger";
+/**
+ * @public
+ */
 export type ReferenceObject = {
     ref: string;
 };
+/**
+ * @public
+ */
 export type FunctionObject = {
@@ -9,11 +15,29 @@ fn: string;
 };
+/**
+ * @public
+ */
 export type FunctionArgv = Array<Expression | boolean | number>;
+/**
+ * @public
+ */
 export type FunctionReturn = string | boolean | number | {
     [key: string]: FunctionReturn;
 };
+/**
+ * @public
+ */
 export type ConditionObject = FunctionObject & {
     assign?: string;
 };
+/**
+ * @public
+ */
 export type Expression = string | ReferenceObject | FunctionObject;
+/**
+ * @public
+ */
 export type EndpointParams = Record<string, string | boolean>;
+/**
+ * @public
+ */
 export type EndpointResolverOptions = {
@@ -23,5 +47,11 @@ endpointParams: EndpointParams;
 };
+/**
+ * @public
+ */
 export type ReferenceRecord = Record<string, FunctionReturn>;
+/**
+ * @public
+ */
 export type EvaluateOptions = EndpointResolverOptions & {
     referenceRecord: ReferenceRecord;
 };

dist-types/endpoints/TreeRuleObject.d.ts

 import { EndpointRuleObject } from "./EndpointRuleObject";
 import { ErrorRuleObject } from "./ErrorRuleObject";
 import { ConditionObject } from "./shared";
+/**
+ * @public
+ */
 export type RuleSetRules = Array<EndpointRuleObject | ErrorRuleObject | TreeRuleObject>;
+/**
+ * @public
+ */
 export type TreeRuleObject = {
@@ -6,0 +12,0 @@ type: "tree";

dist-types/eventStream.d.ts

@@ -19,14 +19,44 @@ import { HttpRequest } from "./http";
 export type MessageHeaders = Record<string, MessageHeaderValue>;
-type HeaderValue<K extends string, V> = {
+/**
+ * @public
+ */
+export type HeaderValue<K extends string, V> = {
     type: K;
     value: V;
 };
+/**
+ * @public
+ */
 export type BooleanHeaderValue = HeaderValue<"boolean", boolean>;
+/**
+ * @public
+ */
 export type ByteHeaderValue = HeaderValue<"byte", number>;
+/**
+ * @public
+ */
 export type ShortHeaderValue = HeaderValue<"short", number>;
+/**
+ * @public
+ */
 export type IntegerHeaderValue = HeaderValue<"integer", number>;
+/**
+ * @public
+ */
 export type LongHeaderValue = HeaderValue<"long", Int64>;
+/**
+ * @public
+ */
 export type BinaryHeaderValue = HeaderValue<"binary", Uint8Array>;
+/**
+ * @public
+ */
 export type StringHeaderValue = HeaderValue<"string", string>;
+/**
+ * @public
+ */
 export type TimestampHeaderValue = HeaderValue<"timestamp", Date>;
+/**
+ * @public
+ */
 export type UuidHeaderValue = HeaderValue<"uuid", string>;
@@ -109,2 +139,1 @@ /**
 }
-export {};

dist-types/extensions/checksum.d.ts

@@ -22,2 +22,3 @@ import { ChecksumConstructor } from "../checksum";
  * @deprecated unused.
+ * @internal
  */
@@ -36,2 +37,3 @@ type ChecksumConfigurationLegacy = {
  * @deprecated will be removed for implicit type.
+ * @internal
  */
@@ -48,2 +50,3 @@ type GetChecksumConfigurationType = (runtimeConfig: Partial<{
 /**
+ * @internal
  * @deprecated will be removed for implicit type.
@@ -50,0 +53,0 @@ */

dist-types/http.d.ts

@@ -52,2 +52,5 @@ import { AbortSignal as DeprecatedAbortSignal } from "./abort";
 export type QueryParameterBag = Record<string, string | Array<string> | null>;
+/**
+ * @public
+ */
 export type FieldOptions = {
@@ -58,2 +61,5 @@ name: string;
 };
+/**
+ * @public
+ */
 export declare enum FieldPosition {
@@ -60,0 +66,0 @@ HEADER = 0,

dist-types/http/httpHandlerInitialization.d.ts

@@ -46,6 +46,7 @@ /// <reference types="node" />
     /**
-     * @deprecated Use {@link requestTimeout}
-     *
+     * This field is deprecated, and requestTimeout should be used instead.
      * The maximum time in milliseconds that a socket may remain idle before it
      * is closed.
+     *
+     * @deprecated Use {@link requestTimeout}
      */
@@ -52,0 +53,0 @@ socketTimeout?: number;

dist-types/serde.d.ts

@@ -74,2 +74,3 @@ import { Endpoint } from "./http";
  * once.
+ * @public
  */
@@ -76,0 +77,0 @@ export interface SdkStreamMixin {

dist-types/streaming-payload/streaming-blob-payload-input-types.d.ts

 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
 import type { Readable } from "stream";
@@ -37,3 +38,3 @@ import type { BlobOptionalType, ReadableStreamOptionalType } from "../externals-check/browser-externals-check";
  *    to pre-narrow these streaming payload blobs. For usage see the readme.md
- *    in the root of the @smithy/types NPM package.
+ *    in the root of the \@smithy/types NPM package.
  */
@@ -40,0 +41,0 @@ export type StreamingBlobPayloadInputTypes = NodeJsRuntimeStreamingBlobPayloadInputTypes | BrowserRuntimeStreamingBlobPayloadInputTypes;

dist-types/transfer.d.ts

@@ -26,2 +26,7 @@ /**
 }
+/**
+ * @public
+ * Values from ALPN Protocol IDs.
+ * @see https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids
+ */
 export declare enum RequestHandlerProtocol {
@@ -32,4 +37,7 @@ HTTP_0_9 = "http/0.9",
 }
+/**
+ * @public
+ */
 export interface RequestContext {
     destination: URL;
 }

dist-types/ts3.4/blob/blob-payload-input-types.d.ts

@@ -38,4 +38,5 @@ /// <reference types="node" />
 /**
+ * @internal
  * @deprecated renamed to BlobPayloadInputTypes.
  */
 export type BlobTypes = BlobPayloadInputTypes;

dist-types/ts3.4/client.d.ts

@@ -50,2 +50,3 @@ import { Command } from "./command";
  * It's provided for using without importing the SmithyClient class.
+ * @internal
  */
@@ -52,0 +53,0 @@ export interface Client<Input extends object, Output extends MetadataBearer, ResolvedClientConfiguration> {

dist-types/ts3.4/connection/config.d.ts

@@ -0,1 +1,4 @@
+/**
+ * @public
+ */
 export interface ConnectConfiguration {
@@ -2,0 +5,0 @@ /**

dist-types/ts3.4/connection/manager.d.ts

 import { RequestContext } from "../transfer";
 import { ConnectConfiguration } from "./config";
+/**
+ * @public
+ */
 export interface ConnectionManagerConfiguration {
@@ -13,2 +16,5 @@ /**
 }
+/**
+ * @public
+ */
 export interface ConnectionManager<T> {
@@ -15,0 +21,0 @@ /**

dist-types/ts3.4/connection/pool.d.ts

@@ -0,1 +1,4 @@
+/**
+ * @public
+ */
 export interface ConnectionPool<T> {
@@ -22,4 +25,9 @@ /**
 }
+/**
+ * Unused.
+ * @internal
+ * @deprecated
+ */
 export interface CacheKey {
     destination: string;
 }

dist-types/ts3.4/encode.d.ts

 import { Message } from "./eventStream";
+/**
+ * @public
+ */
 export interface MessageEncoder {
     encode(message: Message): Uint8Array;
 }
+/**
+ * @public
+ */
 export interface MessageDecoder {
@@ -12,2 +18,5 @@ decode(message: ArrayBufferView): Message;
 }
+/**
+ * @public
+ */
 export interface AvailableMessage {
@@ -17,2 +26,5 @@ getMessage(): Message | undefined;
 }
+/**
+ * @public
+ */
 export interface AvailableMessages {
@@ -19,0 +31,0 @@ getMessages(): Message[];

dist-types/ts3.4/endpoints/EndpointRuleObject.d.ts

 import { EndpointObjectProperty } from "../endpoint";
 import { ConditionObject, Expression } from "./shared";
+/**
+ * @public
+ */
 export type EndpointObjectProperties = Record<string, EndpointObjectProperty>;
+/**
+ * @public
+ */
 export type EndpointObjectHeaders = Record<string, Expression[]>;
+/**
+ * @public
+ */
 export type EndpointObject = {
@@ -10,2 +19,5 @@ url: Expression;
 };
+/**
+ * @public
+ */
 export type EndpointRuleObject = {
@@ -12,0 +24,0 @@ type: "endpoint";

dist-types/ts3.4/endpoints/ErrorRuleObject.d.ts

 import { ConditionObject, Expression } from "./shared";
+/**
+ * @public
+ */
 export type ErrorRuleObject = {
@@ -3,0 +6,0 @@ type: "error";

dist-types/ts3.4/endpoints/RuleSetObject.d.ts

 import { RuleSetRules } from "./TreeRuleObject";
+/**
+ * @public
+ */
 export type DeprecatedObject = {
@@ -6,2 +9,5 @@ message?: string;
 };
+/**
+ * @public
+ */
 export type ParameterObject = {
@@ -15,2 +21,5 @@ type: "String" | "string" | "Boolean" | "boolean";
 };
+/**
+ * @public
+ */
 export type RuleSetObject = {
@@ -17,0 +26,0 @@ version: string;

dist-types/ts3.4/endpoints/shared.d.ts

 import { Logger } from "../logger";
+/**
+ * @public
+ */
 export type ReferenceObject = {
     ref: string;
 };
+/**
+ * @public
+ */
 export type FunctionObject = {
@@ -9,11 +15,29 @@ fn: string;
 };
+/**
+ * @public
+ */
 export type FunctionArgv = Array<Expression | boolean | number>;
+/**
+ * @public
+ */
 export type FunctionReturn = string | boolean | number | {
     [key: string]: FunctionReturn;
 };
+/**
+ * @public
+ */
 export type ConditionObject = FunctionObject & {
     assign?: string;
 };
+/**
+ * @public
+ */
 export type Expression = string | ReferenceObject | FunctionObject;
+/**
+ * @public
+ */
 export type EndpointParams = Record<string, string | boolean>;
+/**
+ * @public
+ */
 export type EndpointResolverOptions = {
@@ -23,5 +47,11 @@ endpointParams: EndpointParams;
 };
+/**
+ * @public
+ */
 export type ReferenceRecord = Record<string, FunctionReturn>;
+/**
+ * @public
+ */
 export type EvaluateOptions = EndpointResolverOptions & {
     referenceRecord: ReferenceRecord;
 };

dist-types/ts3.4/endpoints/TreeRuleObject.d.ts

 import { EndpointRuleObject } from "./EndpointRuleObject";
 import { ErrorRuleObject } from "./ErrorRuleObject";
 import { ConditionObject } from "./shared";
+/**
+ * @public
+ */
 export type RuleSetRules = Array<EndpointRuleObject | ErrorRuleObject | TreeRuleObject>;
+/**
+ * @public
+ */
 export type TreeRuleObject = {
@@ -6,0 +12,0 @@ type: "tree";

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

@@ -19,14 +19,44 @@ import { HttpRequest } from "./http";
 export type MessageHeaders = Record<string, MessageHeaderValue>;
-type HeaderValue<K extends string, V> = {
+/**
+ * @public
+ */
+export type HeaderValue<K extends string, V> = {
     type: K;
     value: V;
 };
+/**
+ * @public
+ */
 export type BooleanHeaderValue = HeaderValue<"boolean", boolean>;
+/**
+ * @public
+ */
 export type ByteHeaderValue = HeaderValue<"byte", number>;
+/**
+ * @public
+ */
 export type ShortHeaderValue = HeaderValue<"short", number>;
+/**
+ * @public
+ */
 export type IntegerHeaderValue = HeaderValue<"integer", number>;
+/**
+ * @public
+ */
 export type LongHeaderValue = HeaderValue<"long", Int64>;
+/**
+ * @public
+ */
 export type BinaryHeaderValue = HeaderValue<"binary", Uint8Array>;
+/**
+ * @public
+ */
 export type StringHeaderValue = HeaderValue<"string", string>;
+/**
+ * @public
+ */
 export type TimestampHeaderValue = HeaderValue<"timestamp", Date>;
+/**
+ * @public
+ */
 export type UuidHeaderValue = HeaderValue<"uuid", string>;
@@ -109,2 +139,1 @@ /**
 }
-export {};

dist-types/ts3.4/extensions/checksum.d.ts

@@ -22,2 +22,3 @@ import { ChecksumConstructor } from "../checksum";
  * @deprecated unused.
+ * @internal
  */
@@ -36,2 +37,3 @@ type ChecksumConfigurationLegacy = {
  * @deprecated will be removed for implicit type.
+ * @internal
  */
@@ -48,2 +50,3 @@ type GetChecksumConfigurationType = (runtimeConfig: Partial<{
 /**
+ * @internal
  * @deprecated will be removed for implicit type.
@@ -50,0 +53,0 @@ */

dist-types/ts3.4/http.d.ts

@@ -52,2 +52,5 @@ import { AbortSignal as DeprecatedAbortSignal } from "./abort";
 export type QueryParameterBag = Record<string, string | Array<string> | null>;
+/**
+ * @public
+ */
 export type FieldOptions = {
@@ -58,2 +61,5 @@ name: string;
 };
+/**
+ * @public
+ */
 export declare enum FieldPosition {
@@ -60,0 +66,0 @@ HEADER = 0,

dist-types/ts3.4/http/httpHandlerInitialization.d.ts

@@ -45,6 +45,7 @@ /// <reference types="node" />
     /**
-     * @deprecated Use {@link requestTimeout}
-     *
+     * This field is deprecated, and requestTimeout should be used instead.
      * The maximum time in milliseconds that a socket may remain idle before it
      * is closed.
+     *
+     * @deprecated Use {@link requestTimeout}
      */
@@ -51,0 +52,0 @@ socketTimeout?: number;

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

@@ -74,2 +74,3 @@ import { Endpoint } from "./http";
  * once.
+ * @public
  */
@@ -76,0 +77,0 @@ export interface SdkStreamMixin {

dist-types/ts3.4/streaming-payload/streaming-blob-payload-input-types.d.ts

@@ -36,3 +36,3 @@ /// <reference types="node" />
  *    to pre-narrow these streaming payload blobs. For usage see the readme.md
- *    in the root of the @smithy/types NPM package.
+ *    in the root of the \@smithy/types NPM package.
  */
@@ -39,0 +39,0 @@ export type StreamingBlobPayloadInputTypes = NodeJsRuntimeStreamingBlobPayloadInputTypes | BrowserRuntimeStreamingBlobPayloadInputTypes;

dist-types/ts3.4/transfer.d.ts

@@ -26,2 +26,7 @@ /**
 }
+/**
+ * @public
+ * Values from ALPN Protocol IDs.
+ * @see https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids
+ */
 export declare enum RequestHandlerProtocol {
@@ -32,4 +37,7 @@ HTTP_0_9 = "http/0.9",
 }
+/**
+ * @public
+ */
 export interface RequestContext {
     destination: URL;
 }

package.json

 {
   "name": "@smithy/types",
-  "version": "3.7.2",
+  "version": "4.0.0",
   "scripts": {
@@ -30,3 +30,3 @@ "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types && yarn build:types:downlevel'",
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=18.0.0"
   },
@@ -33,0 +33,0 @@ "typesVersions": {

No alert changes

Improved metrics

Total package byte prevSize

246247

increased by1.02%

Lines of code

6972

increased by4.18%

No dependency changes