allow TypeScriptIntegration to write prior to the config object liter…

…al (#1054) * allow TypeScriptIntegration to write prior to the config object literal * set new method to internalApi
smithy-lang · Oct 24, 2023 · 1debb82 · 1debb82
1 parent d5eacb5
commit 1debb82
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 10 deletions.
diff --git a/.changeset/great-schools-cheer.md b/.changeset/great-schools-cheer.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/...degen/src/main/java/software/amazon/smithy/typescript/codegen/RuntimeConfigGenerator.java b/...degen/src/main/java/software/amazon/smithy/typescript/codegen/RuntimeConfigGenerator.java
@@ -169,11 +169,17 @@ void generate(LanguageTarget target) {
                     .replaceFirst(CodegenUtils.SOURCE_FOLDER + "/", ""))
                 .replace("${clientConfigName}", symbolProvider.toSymbol(service).getName() + "Config")
                 .replace("${apiVersion}", service.getVersion())
-                .replace("$", "$$") // sanitize template place holders.
-                .replace("$${customizations}", "${L@customizations}");
+                .replace("${", "$${") // sanitize template place holders.
+                .replace("$${customizations}", "${L@customizations}")
+                .replace("$${prepareCustomizations}", "${L@prepareCustomizations}");
 
         delegator.useFileWriter(target.getTargetFilename(), writer -> {
             // Inject customizations into the ~template.
+            writer.onSection("prepareCustomizations", original -> {
+                for (TypeScriptIntegration integration : integrations) {
+                    integration.prepareCustomizations(writer, target, settings, model);
+                }
+            });
             writer.indent().onSection("customizations", original -> {
                 // Start with defaults, use a TreeMap for keeping entries sorted.
                 Map<String, Consumer<TypeScriptWriter>> configs =
@@ -198,7 +204,7 @@ void generate(LanguageTarget target) {
                 });
             });
             writer.dedent();
-            writer.write(contents, "");
+            writer.write(contents, "", "");
         });
     }
 

diff --git a/...ain/java/software/amazon/smithy/typescript/codegen/integration/TypeScriptIntegration.java b/...ain/java/software/amazon/smithy/typescript/codegen/integration/TypeScriptIntegration.java
@@ -253,4 +253,17 @@ default Map<String, Consumer<TypeScriptWriter>> getRuntimeConfigWriters(
     default List<ExtensionConfigurationInterface> getExtensionConfigurationInterfaces() {
         return Collections.emptyList();
     }
+
+    /**
+     * Allows the customization to write arbitrary preparatory code prior to the returned config object.
+     */
+    @SmithyInternalApi
+    default void prepareCustomizations(
+        TypeScriptWriter writer,
+        LanguageTarget target,
+        TypeScriptSettings settings,
+        Model model
+    ) {
+        return;
+    }
 }
diff --git a/...ain/resources/software/amazon/smithy/typescript/codegen/runtimeConfig.browser.ts.template b/...ain/resources/software/amazon/smithy/typescript/codegen/runtimeConfig.browser.ts.template
@@ -10,7 +10,7 @@ export const getRuntimeConfig = (config: ${clientConfigName}) => {
   const defaultsMode = resolveDefaultsModeConfig(config);
   const defaultConfigProvider = () => defaultsMode().then(loadConfigsForDefaultMode);
   const clientSharedValues = getSharedRuntimeConfig(config);
-  return {
+  ${prepareCustomizations}return {
     ...clientSharedValues,
     ...config,
     runtime: "browser",

diff --git a/...main/resources/software/amazon/smithy/typescript/codegen/runtimeConfig.native.ts.template b/...main/resources/software/amazon/smithy/typescript/codegen/runtimeConfig.native.ts.template
@@ -6,7 +6,7 @@ import { getRuntimeConfig as getBrowserRuntimeConfig } from "./runtimeConfig.bro
  */
 export const getRuntimeConfig = (config: ${clientConfigName}) => {
   const browserDefaults = getBrowserRuntimeConfig(config);
-  return {
+  ${prepareCustomizations}return {
     ...browserDefaults,
     ...config,
     runtime: "react-native",

diff --git a/...main/resources/software/amazon/smithy/typescript/codegen/runtimeConfig.shared.ts.template b/...main/resources/software/amazon/smithy/typescript/codegen/runtimeConfig.shared.ts.template
@@ -3,7 +3,9 @@ import { ${clientConfigName} } from "${clientModuleName}";
 /**
  * @internal
  */
-export const getRuntimeConfig = (config: ${clientConfigName}) => ({
-  apiVersion: "${apiVersion}",
-${customizations}
-});
+export const getRuntimeConfig = (config: ${clientConfigName}) => {
+  ${prepareCustomizations}return {
+    apiVersion: "${apiVersion}",
+    ${customizations}
+  }
+};
diff --git a/...en/src/main/resources/software/amazon/smithy/typescript/codegen/runtimeConfig.ts.template b/...en/src/main/resources/software/amazon/smithy/typescript/codegen/runtimeConfig.ts.template
@@ -12,7 +12,7 @@ export const getRuntimeConfig = (config: ${clientConfigName}) => {
   const defaultsMode = resolveDefaultsModeConfig(config);
   const defaultConfigProvider = () => defaultsMode().then(loadConfigsForDefaultMode);
   const clientSharedValues = getSharedRuntimeConfig(config);
-  return {
+  ${prepareCustomizations}return {
     ...clientSharedValues,
     ...config,
     runtime: "node",