fix(codegen): generate access level annotations on endpoint components (#1794)

Author: kuhe

private/my-local-model-schema/src/endpoint/EndpointParameters.ts

@@ -8,10 +8,16 @@ export interface ClientInputEndpointParameters {
   endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
 }
 
+/**
+ * @public
+ */
 export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
   defaultSigningName: string;
 };
 
+/**
+ * @internal
+ */
 export const resolveClientEndpointParameters = <T>(
   options: T & ClientInputEndpointParameters
 ): T & ClientResolvedEndpointParameters => {
@@ -20,10 +26,16 @@ export const resolveClientEndpointParameters = <T>(
   });
 };
 
+/**
+ * @internal
+ */
 export const commonParams = {
   endpoint: { type: "builtInParams", name: "endpoint" },
 } as const;
 
+/**
+ * @internal
+ */
 export interface EndpointParameters extends __EndpointParameters {
   endpoint?: string | undefined;
 }

private/my-local-model-schema/src/endpoint/endpointResolver.ts

@@ -10,6 +10,9 @@ const cache = new EndpointCache({
   params: ["endpoint"],
 });
 
+/**
+ * @internal
+ */
 export const defaultEndpointResolver = (
   endpointParams: EndpointParameters,
   context: { logger?: Logger } = {}

private/my-local-model/src/endpoint/EndpointParameters.ts

@@ -8,10 +8,16 @@ export interface ClientInputEndpointParameters {
   endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
 }
 
+/**
+ * @public
+ */
 export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
   defaultSigningName: string;
 };
 
+/**
+ * @internal
+ */
 export const resolveClientEndpointParameters = <T>(
   options: T & ClientInputEndpointParameters
 ): T & ClientResolvedEndpointParameters => {
@@ -20,10 +26,16 @@ export const resolveClientEndpointParameters = <T>(
   });
 };
 
+/**
+ * @internal
+ */
 export const commonParams = {
   endpoint: { type: "builtInParams", name: "endpoint" },
 } as const;
 
+/**
+ * @internal
+ */
 export interface EndpointParameters extends __EndpointParameters {
   endpoint?: string | undefined;
 }

private/my-local-model/src/endpoint/endpointResolver.ts

@@ -10,6 +10,9 @@ const cache = new EndpointCache({
   params: ["endpoint"],
 });
 
+/**
+ * @internal
+ */
 export const defaultEndpointResolver = (
   endpointParams: EndpointParameters,
   context: { logger?: Logger } = {}

private/smithy-rpcv2-cbor-schema/src/endpoint/EndpointParameters.ts

@@ -8,10 +8,16 @@ export interface ClientInputEndpointParameters {
   endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
 }
 
+/**
+ * @public
+ */
 export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
   defaultSigningName: string;
 };
 
+/**
+ * @internal
+ */
 export const resolveClientEndpointParameters = <T>(
   options: T & ClientInputEndpointParameters
 ): T & ClientResolvedEndpointParameters => {
@@ -20,10 +26,16 @@ export const resolveClientEndpointParameters = <T>(
   });
 };
 
+/**
+ * @internal
+ */
 export const commonParams = {
   endpoint: { type: "builtInParams", name: "endpoint" },
 } as const;
 
+/**
+ * @internal
+ */
 export interface EndpointParameters extends __EndpointParameters {
   endpoint?: string | undefined;
 }

private/smithy-rpcv2-cbor-schema/src/endpoint/endpointResolver.ts

@@ -10,6 +10,9 @@ const cache = new EndpointCache({
   params: ["endpoint"],
 });
 
+/**
+ * @internal
+ */
 export const defaultEndpointResolver = (
   endpointParams: EndpointParameters,
   context: { logger?: Logger } = {}

private/smithy-rpcv2-cbor/src/endpoint/EndpointParameters.ts

@@ -8,10 +8,16 @@ export interface ClientInputEndpointParameters {
   endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
 }
 
+/**
+ * @public
+ */
 export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
   defaultSigningName: string;
 };
 
+/**
+ * @internal
+ */
 export const resolveClientEndpointParameters = <T>(
   options: T & ClientInputEndpointParameters
 ): T & ClientResolvedEndpointParameters => {
@@ -20,10 +26,16 @@ export const resolveClientEndpointParameters = <T>(
   });
 };
 
+/**
+ * @internal
+ */
 export const commonParams = {
   endpoint: { type: "builtInParams", name: "endpoint" },
 } as const;
 
+/**
+ * @internal
+ */
 export interface EndpointParameters extends __EndpointParameters {
   endpoint?: string | undefined;
 }

private/smithy-rpcv2-cbor/src/endpoint/endpointResolver.ts

@@ -10,6 +10,9 @@ const cache = new EndpointCache({
   params: ["endpoint"],
 });
 
+/**
+ * @internal
+ */
 export const defaultEndpointResolver = (
   endpointParams: EndpointParameters,
   context: { logger?: Logger } = {}

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/endpointsV2/EndpointsV2Generator.java

@@ -131,6 +131,7 @@ private void generateEndpointParameters() {
                 );
 
                 writer.write("");
+                writer.writeDocs("@public");
                 writer.openBlock(
                     """
                     export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
@@ -142,6 +143,7 @@ private void generateEndpointParameters() {
                 );
                 writer.write("");
 
+                writer.writeDocs("@internal");
                 writer.openBlock(
                     "export const resolveClientEndpointParameters = "
                         + "<T>(options: T & ClientInputEndpointParameters"
@@ -163,6 +165,7 @@ private void generateEndpointParameters() {
 
                 writer.write("");
 
+                writer.writeDocs("@internal");
                 writer.openBlock(
                     "export const commonParams = {", "} as const",
                     () -> {
@@ -189,6 +192,7 @@ private void generateEndpointParameters() {
                 );
 
                 writer.write("");
+                writer.writeDocs("@internal");
                 writer.openBlock(
                     "export interface EndpointParameters extends __EndpointParameters {",
                     "}",
@@ -234,6 +238,7 @@ private void generateEndpointResolver() {
                         .stream().collect(Collectors.joining("\",\n \"", "\"", "\""))
                 );
 
+                writer.writeDocs("@internal");
                 writer.write(
                 """
                     export const defaultEndpointResolver = (