docs(tsdoc): release tags to types package (#4506)

* docs(add-tsdoc): release tags to types package

* docs(rm-reexport-tags): remove unnecessary release tags from index files

* fix(tsdoc): update release tags

Author: MYoung25

packages/types/src/abort.ts

@@ -1,8 +1,13 @@
+/**
+ * @public
+ */
 export interface AbortHandler {
   (this: AbortSignal, ev: any): any;
 }
 
 /**
+ * @public
+ *
  * Holders of an AbortSignal object may query if the associated operation has
  * been aborted and register an onabort handler.
  *
@@ -22,6 +27,8 @@ export interface AbortSignal {
 }
 
 /**
+ * @public
+ *
  * The AWS SDK uses a Controller/Signal model to allow for cooperative
  * cancellation of asynchronous operations. When initiating such an operation,
  * the caller can create an AbortController and then provide linked signal to

packages/types/src/auth.ts

@@ -1,4 +1,6 @@
 /**
+ * @internal
+ *
  * Authentication schemes represent a way that the service will authenticate the customer’s identity.
  */
 export interface AuthScheme {
@@ -28,6 +30,9 @@ export interface AuthScheme {
 
 // As described in the Smithy documentation:
 // https://github.com/awslabs/smithy/blob/main/smithy-model/src/main/resources/software/amazon/smithy/model/loader/prelude.smithy
+/**
+ * @internal
+ */
 export interface HttpAuthDefinition {
   /**
    * Defines the location of where the Auth is serialized.
@@ -47,6 +52,9 @@ export interface HttpAuthDefinition {
   scheme?: string;
 }
 
+/**
+ * @internal
+ */
 export enum HttpAuthLocation {
   HEADER = "header",
   QUERY = "query",

packages/types/src/checksum.ts

@@ -1,6 +1,8 @@
 import { SourceData } from "./crypto";
 
 /**
+ * @public
+ *
  * An object that provides a checksum of data provided in chunks to `update`.
  * The checksum may be performed incrementally as chunks are received or all
  * at once when the checksum is finalized, depending on the underlying
@@ -57,6 +59,8 @@ export interface Checksum {
 }
 
 /**
+ * @public
+ *
  * A constructor for a Checksum that may be used to calculate an HMAC. Implementing
  * classes should not directly hold the provided key in memory beyond the
  * lexical scope of the constructor.

packages/types/src/client.ts

@@ -3,6 +3,8 @@ import { MiddlewareStack } from "./middleware";
 import { MetadataBearer } from "./response";
 
 /**
+ * @public
+ *
  * function definition for different overrides of client's 'send' function.
  */
 interface InvokeFunction<InputTypes extends object, OutputTypes extends MetadataBearer, ResolvedClientConfiguration> {

packages/types/src/command.ts

@@ -1,6 +1,9 @@
 import { Handler, MiddlewareStack } from "./middleware";
 import { MetadataBearer } from "./response";
 
+/**
+ * @public
+ */
 export interface Command<
   ClientInput extends object,
   InputType extends ClientInput,

packages/types/src/credentials.ts

@@ -2,13 +2,17 @@ import { AwsCredentialIdentity } from "./identity";
 import { Provider } from "./util";
 
 /**
+ * @public
+ *
  * An object representing temporary or permanent AWS credentials.
  *
  * @deprecated Use {@AwsCredentialIdentity}
  */
 export interface Credentials extends AwsCredentialIdentity {}
 
 /**
+ * @public
+ *
  * @deprecated Use {@AwsCredentialIdentityProvider}
  */
 export type CredentialProvider = Provider<Credentials>;

packages/types/src/crypto.ts

@@ -1,6 +1,11 @@
+/**
+ * @public
+ */
 export type SourceData = string | ArrayBuffer | ArrayBufferView;
 
 /**
+ * @public
+ *
  * An object that provides a hash of data provided in chunks to `update`. The
  * hash may be performed incrementally as chunks are received or all at once
  * when the hash is finalized, depending on the underlying implementation.
@@ -26,6 +31,8 @@ export interface Hash {
 }
 
 /**
+ * @public
+ *
  * A constructor for a hash that may be used to calculate an HMAC. Implementing
  * classes should not directly hold the provided key in memory beyond the
  * lexical scope of the constructor.
@@ -37,6 +44,8 @@ export interface HashConstructor {
 }
 
 /**
+ * @public
+ *
  * A function that calculates the hash of a data stream. Determining the hash
  * will consume the stream, so only replayable streams should be provided to an
  * implementation of this interface.
@@ -46,6 +55,8 @@ export interface StreamHasher<StreamType = any> {
 }
 
 /**
+ * @public
+ *
  * A function that returns a promise fulfilled with bytes from a
  * cryptographically secure pseudorandom number generator.
  */

packages/types/src/dns.ts

@@ -1,4 +1,6 @@
 /**
+ * @public
+ *
  * DNS record types
  */
 export enum HostAddressType {
@@ -12,6 +14,9 @@ export enum HostAddressType {
   A = "A",
 }
 
+/**
+ * @public
+ */
 export interface HostAddress {
   /**
    * The {@link HostAddressType} of the host address.
@@ -32,6 +37,9 @@ export interface HostAddress {
   service?: string;
 }
 
+/**
+ * @public
+ */
 export interface HostResolverArguments {
   /**
    * The host name to resolve.
@@ -44,6 +52,8 @@ export interface HostResolverArguments {
 }
 
 /**
+ * @public
+ *
  * Host Resolver interface for DNS queries
  */
 export interface HostResolver {

packages/types/src/endpoint.ts

@@ -1,5 +1,8 @@
 import { AuthScheme } from "./auth";
 
+/**
+ * @public
+ */
 export interface EndpointPartition {
   name: string;
   dnsSuffix: string;
@@ -8,6 +11,9 @@ export interface EndpointPartition {
   supportsDualStack: boolean;
 }
 
+/**
+ * @public
+ */
 export interface EndpointARN {
   partition: string;
   service: string;
@@ -16,11 +22,17 @@ export interface EndpointARN {
   resourceId: Array<string>;
 }
 
+/**
+ * @public
+ */
 export enum EndpointURLScheme {
   HTTP = "http",
   HTTPS = "https",
 }
 
+/**
+ * @public
+ */
 export interface EndpointURL {
   /**
    * The URL scheme such as http or https.
@@ -50,12 +62,18 @@ export interface EndpointURL {
   isIp: boolean;
 }
 
+/**
+ * @public
+ */
 export type EndpointObjectProperty =
   | string
   | boolean
   | { [key: string]: EndpointObjectProperty }
   | EndpointObjectProperty[];
 
+/**
+ * @public
+ */
 export interface EndpointV2 {
   url: URL;
   properties?: {
@@ -64,4 +82,7 @@ export interface EndpointV2 {
   headers?: Record<string, string[]>;
 }
 
+/**
+ * @public
+ */
 export type EndpointParameters = { [name: string]: undefined | string | boolean };