docs(add-private): add @internal tags to all internal packages (#4593)

aws · Mar 30, 2023 · d077067 · d077067
1 parent 4bef620
commit d077067
Show file tree

Hide file tree

Showing 190 changed files with 1,010 additions and 5 deletions.
diff --git a/packages/body-checksum-browser/src/index.ts b/packages/body-checksum-browser/src/index.ts
@@ -6,6 +6,9 @@ import { toUint8Array } from "@aws-sdk/util-utf8";
 
 const MiB = 1024 * 1024;
 
+/**
+ * @internal
+ */
 export async function bodyChecksumGenerator(
   request: HttpRequest,
   options: {

diff --git a/packages/body-checksum-node/src/index.ts b/packages/body-checksum-node/src/index.ts
@@ -6,6 +6,9 @@ import { toHex } from "@aws-sdk/util-hex-encoding";
 import { toUint8Array } from "@aws-sdk/util-utf8";
 import { createReadStream } from "fs";
 
+/**
+ * @internal
+ */
 export async function bodyChecksumGenerator(
   request: HttpRequest,
   options: {

diff --git a/packages/chunked-blob-reader-native/src/index.ts b/packages/chunked-blob-reader-native/src/index.ts
@@ -1,4 +1,7 @@
 import { fromBase64 } from "@aws-sdk/util-base64";
+/**
+ * @internal
+ */
 export function blobReader(
   blob: Blob,
   onChunk: (chunk: Uint8Array) => void,

diff --git a/packages/chunked-blob-reader/src/index.ts b/packages/chunked-blob-reader/src/index.ts
@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export function blobReader(
   blob: Blob,
   onChunk: (chunk: Uint8Array) => void,

diff --git a/packages/chunked-stream-reader-node/src/index.ts b/packages/chunked-stream-reader-node/src/index.ts
@@ -1,4 +1,7 @@
 import { Readable } from "stream";
+/**
+ * @internal
+ */
 export function streamReader(
   stream: Readable,
   onChunk: (chunk: Uint8Array) => void,

diff --git a/packages/chunked-stream-reader-node/src/readable.fixture.ts b/packages/chunked-stream-reader-node/src/readable.fixture.ts
@@ -1,10 +1,16 @@
 import { Readable, ReadableOptions } from "stream";
 
+/**
+ * @internal
+ */
 export interface ReadFromBuffersOptions extends ReadableOptions {
   buffers: Buffer[];
   errorAfter?: number;
 }
 
+/**
+ * @internal
+ */
 export class ReadFromBuffers extends Readable {
   private buffersToRead: Buffer[];
   private numBuffersRead = 0;

diff --git a/packages/config-resolver/src/endpointsConfig/NodeUseDualstackEndpointConfigOptions.ts b/packages/config-resolver/src/endpointsConfig/NodeUseDualstackEndpointConfigOptions.ts
@@ -1,10 +1,22 @@
 import { LoadedConfigSelectors } from "@aws-sdk/node-config-provider";
 import { booleanSelector, SelectorType } from "@aws-sdk/util-config-provider";
 
+/**
+ * @internal
+ */
 export const ENV_USE_DUALSTACK_ENDPOINT = "AWS_USE_DUALSTACK_ENDPOINT";
+/**
+ * @internal
+ */
 export const CONFIG_USE_DUALSTACK_ENDPOINT = "use_dualstack_endpoint";
+/**
+ * @internal
+ */
 export const DEFAULT_USE_DUALSTACK_ENDPOINT = false;
 
+/**
+ * @internal
+ */
 export const NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS: LoadedConfigSelectors<boolean> = {
   environmentVariableSelector: (env: NodeJS.ProcessEnv) =>
     booleanSelector(env, ENV_USE_DUALSTACK_ENDPOINT, SelectorType.ENV),

diff --git a/packages/config-resolver/src/endpointsConfig/NodeUseFipsEndpointConfigOptions.ts b/packages/config-resolver/src/endpointsConfig/NodeUseFipsEndpointConfigOptions.ts
@@ -1,10 +1,22 @@
 import { LoadedConfigSelectors } from "@aws-sdk/node-config-provider";
 import { booleanSelector, SelectorType } from "@aws-sdk/util-config-provider";
 
+/**
+ * @internal
+ */
 export const ENV_USE_FIPS_ENDPOINT = "AWS_USE_FIPS_ENDPOINT";
+/**
+ * @internal
+ */
 export const CONFIG_USE_FIPS_ENDPOINT = "use_fips_endpoint";
+/**
+ * @internal
+ */
 export const DEFAULT_USE_FIPS_ENDPOINT = false;
 
+/**
+ * @internal
+ */
 export const NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS: LoadedConfigSelectors<boolean> = {
   environmentVariableSelector: (env: NodeJS.ProcessEnv) =>
     booleanSelector(env, ENV_USE_FIPS_ENDPOINT, SelectorType.ENV),

diff --git a/packages/config-resolver/src/endpointsConfig/index.ts b/packages/config-resolver/src/endpointsConfig/index.ts
@@ -1,4 +1,16 @@
+/**
+ * @internal
+ */
 export * from "./NodeUseDualstackEndpointConfigOptions";
+/**
+ * @internal
+ */
 export * from "./NodeUseFipsEndpointConfigOptions";
+/**
+ * @internal
+ */
 export * from "./resolveCustomEndpointsConfig";
+/**
+ * @internal
+ */
 export * from "./resolveEndpointsConfig";
diff --git a/packages/config-resolver/src/endpointsConfig/resolveCustomEndpointsConfig.ts b/packages/config-resolver/src/endpointsConfig/resolveCustomEndpointsConfig.ts
@@ -3,6 +3,9 @@ import { normalizeProvider } from "@aws-sdk/util-middleware";
 
 import { EndpointsInputConfig, EndpointsResolvedConfig } from "./resolveEndpointsConfig";
 
+/**
+ * @internal
+ */
 export interface CustomEndpointsInputConfig extends EndpointsInputConfig {
   /**
    * The fully qualified endpoint of the webservice.
@@ -14,6 +17,9 @@ interface PreviouslyResolved {
   urlParser: UrlParser;
 }
 
+/**
+ * @internal
+ */
 export interface CustomEndpointsResolvedConfig extends EndpointsResolvedConfig {
   /**
    * Whether the endpoint is specified by caller.
@@ -22,6 +28,9 @@ export interface CustomEndpointsResolvedConfig extends EndpointsResolvedConfig {
   isCustomEndpoint: true;
 }
 
+/**
+ * @internal
+ */
 export const resolveCustomEndpointsConfig = <T>(
   input: T & CustomEndpointsInputConfig & PreviouslyResolved
 ): T & CustomEndpointsResolvedConfig => {

diff --git a/packages/config-resolver/src/endpointsConfig/resolveEndpointsConfig.ts b/packages/config-resolver/src/endpointsConfig/resolveEndpointsConfig.ts
@@ -3,6 +3,9 @@ import { normalizeProvider } from "@aws-sdk/util-middleware";
 
 import { getEndpointFromRegion } from "./utils/getEndpointFromRegion";
 
+/**
+ * @internal
+ */
 export interface EndpointsInputConfig {
   /**
    * The fully qualified endpoint of the webservice. This is only required when using
@@ -28,6 +31,9 @@ interface PreviouslyResolved {
   useFipsEndpoint: Provider<boolean>;
 }
 
+/**
+ * @internal
+ */
 export interface EndpointsResolvedConfig extends Required<EndpointsInputConfig> {
   /**
    * Resolved value for input {@link EndpointsInputConfig.endpoint}
@@ -47,6 +53,8 @@ export interface EndpointsResolvedConfig extends Required<EndpointsInputConfig>
 }
 
 /**
+ * @internal
+ * 
  * @deprecated endpoints rulesets use @aws-sdk/middleware-endpoint resolveEndpointConfig.
  * All generated clients should migrate to Endpoints 2.0 endpointRuleSet traits.
  */

diff --git a/packages/config-resolver/src/index.ts b/packages/config-resolver/src/index.ts
@@ -1,3 +1,12 @@
+/**
+ * @internal
+ */
 export * from "./endpointsConfig";
+/**
+ * @internal
+ */
 export * from "./regionConfig";
+/**
+ * @internal
+ */
 export * from "./regionInfo";
diff --git a/packages/config-resolver/src/regionConfig/config.ts b/packages/config-resolver/src/regionConfig/config.ts
@@ -1,8 +1,17 @@
 import { LoadedConfigSelectors, LocalConfigOptions } from "@aws-sdk/node-config-provider";
 
+/**
+ * @internal
+ */
 export const REGION_ENV_NAME = "AWS_REGION";
+/**
+ * @internal
+ */
 export const REGION_INI_NAME = "region";
 
+/**
+ * @internal
+ */
 export const NODE_REGION_CONFIG_OPTIONS: LoadedConfigSelectors<string> = {
   environmentVariableSelector: (env) => env[REGION_ENV_NAME],
   configFileSelector: (profile) => profile[REGION_INI_NAME],
@@ -11,6 +20,9 @@ export const NODE_REGION_CONFIG_OPTIONS: LoadedConfigSelectors<string> = {
   },
 };
 
+/**
+ * @internal
+ */
 export const NODE_REGION_CONFIG_FILE_OPTIONS: LocalConfigOptions = {
   preferredFile: "credentials",
 };
diff --git a/packages/config-resolver/src/regionConfig/getRealRegion.ts b/packages/config-resolver/src/regionConfig/getRealRegion.ts
@@ -1,5 +1,8 @@
 import { isFipsRegion } from "./isFipsRegion";
 
+/**
+ * @internal
+ */
 export const getRealRegion = (region: string) =>
   isFipsRegion(region)
     ? ["fips-aws-global", "aws-fips"].includes(region)

diff --git a/packages/config-resolver/src/regionConfig/index.ts b/packages/config-resolver/src/regionConfig/index.ts
@@ -1,2 +1,8 @@
+/**
+ * @internal
+ */
 export * from "./config";
+/**
+ * @internal
+ */
 export * from "./resolveRegionConfig";
diff --git a/packages/config-resolver/src/regionConfig/isFipsRegion.ts b/packages/config-resolver/src/regionConfig/isFipsRegion.ts
@@ -1,2 +1,5 @@
+/**
+ * @internal
+ */
 export const isFipsRegion = (region: string) =>
   typeof region === "string" && (region.startsWith("fips-") || region.endsWith("-fips"));
diff --git a/packages/config-resolver/src/regionConfig/resolveRegionConfig.ts b/packages/config-resolver/src/regionConfig/resolveRegionConfig.ts
@@ -3,6 +3,9 @@ import { Provider } from "@aws-sdk/types";
 import { getRealRegion } from "./getRealRegion";
 import { isFipsRegion } from "./isFipsRegion";
 
+/**
+ * @internal
+ */
 export interface RegionInputConfig {
   /**
    * The AWS region to which this client will send requests
@@ -17,6 +20,9 @@ export interface RegionInputConfig {
 
 interface PreviouslyResolved {}
 
+/**
+ * @internal
+ */
 export interface RegionResolvedConfig {
   /**
    * Resolved value for input config {@link RegionInputConfig.region}
@@ -29,6 +35,9 @@ export interface RegionResolvedConfig {
   useFipsEndpoint: Provider<boolean>;
 }
 
+/**
+ * @internal
+ */
 export const resolveRegionConfig = <T>(input: T & RegionInputConfig & PreviouslyResolved): T & RegionResolvedConfig => {
   const { region, useFipsEndpoint } = input;
 

diff --git a/packages/config-resolver/src/regionInfo/EndpointVariant.ts b/packages/config-resolver/src/regionInfo/EndpointVariant.ts
@@ -1,6 +1,8 @@
 import { EndpointVariantTag } from "./EndpointVariantTag";
 
 /**
+ * @internal
+ * 
  * Provides hostname information for specific host label.
  */
 export type EndpointVariant = {

diff --git a/packages/config-resolver/src/regionInfo/EndpointVariantTag.ts b/packages/config-resolver/src/regionInfo/EndpointVariantTag.ts
@@ -1,4 +1,6 @@
 /**
+ * @internal
+ * 
  * The tag which mentions which area variant is providing information for.
  * Can be either "fips" or "dualstack".
  */

diff --git a/packages/config-resolver/src/regionInfo/PartitionHash.ts b/packages/config-resolver/src/regionInfo/PartitionHash.ts
@@ -1,6 +1,8 @@
 import { EndpointVariant } from "./EndpointVariant";
 
 /**
+ * @internal
+ * 
  * The hash of partition with the information specific to that partition.
  * The information includes the list of regions belonging to that partition,
  * and the hostname to be used for the partition.

diff --git a/packages/config-resolver/src/regionInfo/RegionHash.ts b/packages/config-resolver/src/regionInfo/RegionHash.ts
@@ -1,6 +1,8 @@
 import { EndpointVariant } from "./EndpointVariant";
 
 /**
+ * @internal
+ * 
  * The hash of region with the information specific to that region.
  * The information can include hostname, signingService and signingRegion.
  */

diff --git a/packages/config-resolver/src/regionInfo/getHostnameFromVariants.ts b/packages/config-resolver/src/regionInfo/getHostnameFromVariants.ts
@@ -1,10 +1,16 @@
 import { EndpointVariant } from "./EndpointVariant";
 
+/**
+ * @internal
+ */
 export interface GetHostnameFromVariantsOptions {
   useFipsEndpoint: boolean;
   useDualstackEndpoint: boolean;
 }
 
+/**
+ * @internal
+ */
 export const getHostnameFromVariants = (
   variants: EndpointVariant[] = [],
   { useFipsEndpoint, useDualstackEndpoint }: GetHostnameFromVariantsOptions

diff --git a/packages/config-resolver/src/regionInfo/getRegionInfo.ts b/packages/config-resolver/src/regionInfo/getRegionInfo.ts
@@ -7,6 +7,9 @@ import { getResolvedSigningRegion } from "./getResolvedSigningRegion";
 import { PartitionHash } from "./PartitionHash";
 import { RegionHash } from "./RegionHash";
 
+/**
+ * @internal
+ */
 export interface GetRegionInfoOptions {
   useFipsEndpoint?: boolean;
   useDualstackEndpoint?: boolean;
@@ -15,6 +18,9 @@ export interface GetRegionInfoOptions {
   partitionHash: PartitionHash;
 }
 
+/**
+ * @internal
+ */
 export const getRegionInfo = (
   region: string,
   {

diff --git a/packages/config-resolver/src/regionInfo/getResolvedHostname.ts b/packages/config-resolver/src/regionInfo/getResolvedHostname.ts
@@ -1,8 +1,14 @@
+/**
+ * @internal
+ */
 export interface GetResolvedHostnameOptions {
   regionHostname?: string;
   partitionHostname?: string;
 }
 
+/**
+ * @internal
+ */
 export const getResolvedHostname = (
   resolvedRegion: string,
   { regionHostname, partitionHostname }: GetResolvedHostnameOptions

diff --git a/packages/config-resolver/src/regionInfo/getResolvedPartition.ts b/packages/config-resolver/src/regionInfo/getResolvedPartition.ts
@@ -1,8 +1,14 @@
 import { PartitionHash } from "./PartitionHash";
 
+/**
+ * @internal
+ */
 export interface GetResolvedPartitionOptions {
   partitionHash: PartitionHash;
 }
 
+/**
+ * @internal
+ */
 export const getResolvedPartition = (region: string, { partitionHash }: GetResolvedPartitionOptions) =>
   Object.keys(partitionHash || {}).find((key) => partitionHash[key].regions.includes(region)) ?? "aws";
diff --git a/packages/config-resolver/src/regionInfo/getResolvedSigningRegion.ts b/packages/config-resolver/src/regionInfo/getResolvedSigningRegion.ts
@@ -1,9 +1,15 @@
+/**
+ * @internal
+ */
 export interface GetResolvedSigningRegionOptions {
   regionRegex: string;
   signingRegion?: string;
   useFipsEndpoint: boolean;
 }
 
+/**
+ * @internal
+ */
 export const getResolvedSigningRegion = (
   hostname: string,
   { signingRegion, regionRegex, useFipsEndpoint }: GetResolvedSigningRegionOptions