diff --git a/.changeset/ten-frogs-help.md b/.changeset/ten-frogs-help.md new file mode 100644 index 00000000000..518918810d1 --- /dev/null +++ b/.changeset/ten-frogs-help.md @@ -0,0 +1,11 @@ +--- +"@smithy/eventstream-serde-config-resolver": patch +"@smithy/middleware-apply-body-checksum": patch +"@smithy/middleware-endpoint": patch +"@smithy/middleware-retry": patch +"@smithy/config-resolver": patch +"@smithy/smithy-client": patch +"@smithy/types": patch +--- + +add release tag public to client init interface components diff --git a/packages/config-resolver/src/endpointsConfig/resolveCustomEndpointsConfig.ts b/packages/config-resolver/src/endpointsConfig/resolveCustomEndpointsConfig.ts index bb1f6222c0f..c261cf28bab 100644 --- a/packages/config-resolver/src/endpointsConfig/resolveCustomEndpointsConfig.ts +++ b/packages/config-resolver/src/endpointsConfig/resolveCustomEndpointsConfig.ts @@ -4,7 +4,7 @@ import { normalizeProvider } from "@smithy/util-middleware"; import { EndpointsInputConfig, EndpointsResolvedConfig } from "./resolveEndpointsConfig"; /** - * @internal + * @public */ export interface CustomEndpointsInputConfig extends EndpointsInputConfig { /** diff --git a/packages/config-resolver/src/endpointsConfig/resolveEndpointsConfig.ts b/packages/config-resolver/src/endpointsConfig/resolveEndpointsConfig.ts index 9bfb0c6f7e5..5e66f81fb76 100644 --- a/packages/config-resolver/src/endpointsConfig/resolveEndpointsConfig.ts +++ b/packages/config-resolver/src/endpointsConfig/resolveEndpointsConfig.ts @@ -4,7 +4,7 @@ import { normalizeProvider } from "@smithy/util-middleware"; import { getEndpointFromRegion } from "./utils/getEndpointFromRegion"; /** - * @internal + * @public */ export interface EndpointsInputConfig { /** diff --git a/packages/config-resolver/src/regionConfig/resolveRegionConfig.ts b/packages/config-resolver/src/regionConfig/resolveRegionConfig.ts index 48b29eb318c..b0e2289984e 100644 --- a/packages/config-resolver/src/regionConfig/resolveRegionConfig.ts +++ b/packages/config-resolver/src/regionConfig/resolveRegionConfig.ts @@ -4,7 +4,7 @@ import { getRealRegion } from "./getRealRegion"; import { isFipsRegion } from "./isFipsRegion"; /** - * @internal + * @public */ export interface RegionInputConfig { /** diff --git a/packages/eventstream-serde-config-resolver/src/EventStreamSerdeConfig.ts b/packages/eventstream-serde-config-resolver/src/EventStreamSerdeConfig.ts index 8ee4290e1aa..be04cadbf08 100644 --- a/packages/eventstream-serde-config-resolver/src/EventStreamSerdeConfig.ts +++ b/packages/eventstream-serde-config-resolver/src/EventStreamSerdeConfig.ts @@ -1,7 +1,7 @@ import { EventStreamMarshaller, EventStreamSerdeProvider } from "@smithy/types"; /** - * @internal + * @public */ export interface EventStreamSerdeInputConfig {} diff --git a/packages/middleware-apply-body-checksum/src/md5Configuration.ts b/packages/middleware-apply-body-checksum/src/md5Configuration.ts index 8c3b062ca64..720c20dded2 100644 --- a/packages/middleware-apply-body-checksum/src/md5Configuration.ts +++ b/packages/middleware-apply-body-checksum/src/md5Configuration.ts @@ -1,5 +1,8 @@ import { ChecksumConstructor, Encoder, HashConstructor, StreamHasher } from "@smithy/types"; +/** + * @public + */ export interface Md5BodyChecksumInputConfig {} interface PreviouslyResolved { md5: ChecksumConstructor | HashConstructor; diff --git a/packages/middleware-endpoint/src/resolveEndpointConfig.ts b/packages/middleware-endpoint/src/resolveEndpointConfig.ts index 41e24bad2fe..c786f163383 100644 --- a/packages/middleware-endpoint/src/resolveEndpointConfig.ts +++ b/packages/middleware-endpoint/src/resolveEndpointConfig.ts @@ -4,7 +4,7 @@ import { normalizeProvider } from "@smithy/util-middleware"; import { toEndpointV1 } from "./adaptors/toEndpointV1"; /** - * @internal + * @public * * Endpoint config interfaces and resolver for Endpoint v2. They live in separate package to allow per-service onboarding. * When all services onboard Endpoint v2, the resolver in config-resolver package can be removed. diff --git a/packages/middleware-retry/src/configurations.ts b/packages/middleware-retry/src/configurations.ts index 33c0a671854..a0c70811bef 100644 --- a/packages/middleware-retry/src/configurations.ts +++ b/packages/middleware-retry/src/configurations.ts @@ -34,6 +34,9 @@ export const NODE_MAX_ATTEMPT_CONFIG_OPTIONS: LoadedConfigSelectors = { default: DEFAULT_MAX_ATTEMPTS, }; +/** + * @public + */ export interface RetryInputConfig { /** * The maximum number of times requests that encounter retryable failures should be attempted. diff --git a/packages/smithy-client/src/client.ts b/packages/smithy-client/src/client.ts index 1aa23807ba5..c035f83646e 100644 --- a/packages/smithy-client/src/client.ts +++ b/packages/smithy-client/src/client.ts @@ -2,7 +2,7 @@ import { constructStack } from "@smithy/middleware-stack"; import { Client as IClient, Command, MetadataBearer, MiddlewareStack, RequestHandler } from "@smithy/types"; /** - * @internal + * @public */ export interface SmithyConfiguration { requestHandler: RequestHandler; diff --git a/packages/smithy-client/src/defaults-mode.ts b/packages/smithy-client/src/defaults-mode.ts index 13767bf095e..a7013c61a75 100644 --- a/packages/smithy-client/src/defaults-mode.ts +++ b/packages/smithy-client/src/defaults-mode.ts @@ -38,7 +38,7 @@ export const loadConfigsForDefaultMode = (mode: ResolvedDefaultsMode): DefaultsM * * `"auto"`:

The AUTO mode is an experimental mode that builds on the standard mode. The SDK will attempt to discover the execution environment to determine the appropriate settings automatically.

Note that the auto detection is heuristics-based and does not guarantee 100% accuracy. STANDARD mode will be used if the execution environment cannot be determined. The auto detection might query EC2 Instance Metadata service, which might introduce latency. Therefore we recommend choosing an explicit defaults_mode instead if startup latency is critical to your application

* * `"legacy"`:

The LEGACY mode provides default settings that vary per SDK and were used prior to establishment of defaults_mode

* - * @default "legacy" + * @defaultValue "legacy" */ export type DefaultsMode = "standard" | "in-region" | "cross-region" | "mobile" | "auto" | "legacy"; diff --git a/packages/types/src/client.ts b/packages/types/src/client.ts index cb92b23c4a8..81cdaec5ddf 100644 --- a/packages/types/src/client.ts +++ b/packages/types/src/client.ts @@ -33,7 +33,7 @@ export interface InvokeFunction< } /** - * @internal + * @public * * Signature that appears on aggregated clients' methods. */ diff --git a/packages/types/src/response.ts b/packages/types/src/response.ts index 93a2a798ddb..c9a1b1eb94f 100644 --- a/packages/types/src/response.ts +++ b/packages/types/src/response.ts @@ -1,5 +1,5 @@ /** - * @internal + * @public */ export interface ResponseMetadata { /** diff --git a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/endpointsV2/EndpointsV2Generator.java b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/endpointsV2/EndpointsV2Generator.java index dc5b57bd42e..d3f3ac799e2 100644 --- a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/endpointsV2/EndpointsV2Generator.java +++ b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/endpointsV2/EndpointsV2Generator.java @@ -72,6 +72,7 @@ private void generateEndpointParameters() { writer.addImport("EndpointParameters", "__EndpointParameters", TypeScriptDependency.SMITHY_TYPES); writer.addImport("Provider", null, TypeScriptDependency.SMITHY_TYPES); + writer.writeDocs("@public"); writer.openBlock( "export interface ClientInputEndpointParameters {", "}",