(ts, feature): introduce custom config for tolerateRepublish to re …

…publish npm versions (#3093) * (ts, feature): introduce custom config * fix compile
fern-api · Mar 1, 2024 · caeffc1 · caeffc1
1 parent f8206c8
commit caeffc1
Show file tree

Hide file tree

Showing 11 changed files with 53 additions and 10 deletions.
diff --git a/generators/csharp/model/src/ModelGeneratorCli.ts b/generators/csharp/model/src/ModelGeneratorCli.ts
@@ -40,4 +40,8 @@ export class ModelGeneratorCLI extends AbstractGeneratorCli<ModelCustomConfigSch
         generatorContext.logger.info("Received IR", JSON.stringify(intermediateRepresentation, null, 2));
         await writeFile(`/${config.output.path}/ir.json`, JSON.stringify(intermediateRepresentation, null, 2));
     }
+
+    protected shouldTolerateRepublish(customConfig: ModelCustomConfigSchema): boolean {
+        return false;
+    }
 }
diff --git a/generators/typescript/express/cli/src/ExpressGeneratorCli.ts b/generators/typescript/express/cli/src/ExpressGeneratorCli.ts
@@ -73,4 +73,8 @@ export class ExpressGeneratorCli extends AbstractGeneratorCli<ExpressCustomConfi
     protected outputSourceFiles(customConfig: ExpressCustomConfig): boolean {
         return customConfig.outputSourceFiles;
     }
+
+    protected shouldTolerateRepublish(customConfig: ExpressCustomConfig): boolean {
+        return false;
+    }
 }
diff --git a/generators/typescript/sdk/CHANGELOG.md b/generators/typescript/sdk/CHANGELOG.md
@@ -5,7 +5,25 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.12.3-rc1] - 2024-02-27
+## [0.12.5] - 2024-02-27
+
+- Introduce a custom configuration called `tolerateRepublish` which supports running
+  npm publish with the flag `--tolerateRepublish`. This flag allows you to publish 
+  on top of an existing npm package. 
+
+  To turn on this flag, update your generators.yml: 
+
+  ```yaml
+  groups: 
+    generators: 
+      - name: fernapi/fern-typscript-node-sdk
+        version: 0.12.5
+        ...
+        config: 
+          tolerateRepublish: true
+  ```
+
+## [0.12.4] - 2024-02-27
 
 - Fix: Previously reference.md was just leveraging the function name for the reference, now it leverages the full package-scoped path, mirroring how the function would be used in reality.
 
@@ -17,8 +35,6 @@ seedExamples.getException(...)
 seedExamples.file.notification.service.getException(...)
 ```
 
-## [0.12.3-rc1] - 2024-02-27
-
 - Fix: Previously SDK code snippets would not support generation with undiscriminated unions. Now, it does.
 
 ## [0.12.2] - 2024-02-27

diff --git a/generators/typescript/sdk/VERSION b/generators/typescript/sdk/VERSION
@@ -1 +1 @@
-0.12.4
+0.12.5
diff --git a/generators/typescript/sdk/cli/src/SdkGeneratorCli.ts b/generators/typescript/sdk/cli/src/SdkGeneratorCli.ts
@@ -47,7 +47,8 @@ export class SdkGeneratorCli extends AbstractGeneratorCli<SdkCustomConfig> {
             includeContentHeadersOnFileDownloadResponse: parsed?.includeContentHeadersOnFileDownloadResponse ?? false,
             noSerdeLayer,
             noOptionalProperties: parsed?.noOptionalProperties ?? false,
-            includeApiReference: parsed?.includeApiReference ?? false
+            includeApiReference: parsed?.includeApiReference ?? false,
+            tolerateRepublish: parsed?.tolerateRepublish ?? false
         };
     }
 
@@ -99,7 +100,8 @@ export class SdkGeneratorCli extends AbstractGeneratorCli<SdkCustomConfig> {
                 includeContentHeadersOnFileDownloadResponse: customConfig.includeContentHeadersOnFileDownloadResponse,
                 includeSerdeLayer: !customConfig.noSerdeLayer,
                 noOptionalProperties: customConfig.noOptionalProperties,
-                includeApiReference: customConfig.includeApiReference ?? false
+                includeApiReference: customConfig.includeApiReference ?? false,
+                tolerateRepublish: customConfig.tolerateRepublish
             }
         });
         const typescriptProject = await sdkGenerator.generate();
@@ -118,4 +120,8 @@ export class SdkGeneratorCli extends AbstractGeneratorCli<SdkCustomConfig> {
     protected outputSourceFiles(customConfig: SdkCustomConfig): boolean {
         return customConfig.outputSourceFiles;
     }
+
+    protected shouldTolerateRepublish(customConfig: SdkCustomConfig): boolean {
+        return customConfig.tolerateRepublish;
+    }
 }
diff --git a/generators/typescript/sdk/cli/src/custom-config/SdkCustomConfig.ts b/generators/typescript/sdk/cli/src/custom-config/SdkCustomConfig.ts
@@ -22,4 +22,5 @@ export interface SdkCustomConfig {
     noSerdeLayer: boolean;
     noOptionalProperties: boolean;
     includeApiReference: boolean | undefined;
+    tolerateRepublish: boolean; 
 }
diff --git a/generators/typescript/sdk/cli/src/custom-config/schema/SdkCustomConfigSchema.ts b/generators/typescript/sdk/cli/src/custom-config/schema/SdkCustomConfigSchema.ts
@@ -18,6 +18,7 @@ export const SdkCustomConfigSchema = z.strictObject({
     treatUnknownAsAny: z.optional(z.boolean()),
     noSerdeLayer: z.optional(z.boolean()),
     noOptionalProperties: z.optional(z.boolean()),
+    tolerateRepublish: z.optional(z.boolean()),
 
     // beta (not in docs)
     includeContentHeadersOnFileDownloadResponse: z.optional(z.boolean()),

diff --git a/generators/typescript/sdk/generator/src/SdkGenerator.ts b/generators/typescript/sdk/generator/src/SdkGenerator.ts
@@ -91,6 +91,7 @@ export declare namespace SdkGenerator {
         includeSerdeLayer: boolean;
         noOptionalProperties: boolean;
         includeApiReference: boolean;
+        tolerateRepublish: boolean;
     }
 }
 

diff --git a/generators/typescript/utils/abstract-generator-cli/src/AbstractGeneratorCli.ts b/generators/typescript/utils/abstract-generator-cli/src/AbstractGeneratorCli.ts
@@ -97,7 +97,8 @@ export abstract class AbstractGeneratorCli<CustomConfig> {
                         npmPackage,
                         dryRun: config.dryRun,
                         generatorNotificationService,
-                        typescriptProject
+                        typescriptProject,
+                        shouldTolerateRepublish: this.shouldTolerateRepublish(customConfig)
                     });
                     await typescriptProject.npmPackAsZipTo({
                         logger,
@@ -170,6 +171,7 @@ export abstract class AbstractGeneratorCli<CustomConfig> {
     }): Promise<PersistedTypescriptProject>;
     protected abstract isPackagePrivate(customConfig: CustomConfig): boolean;
     protected abstract outputSourceFiles(customConfig: CustomConfig): boolean;
+    protected abstract shouldTolerateRepublish(customConfig: CustomConfig): boolean;
 }
 
 class GeneratorContextImpl implements GeneratorContext {

diff --git a/generators/typescript/utils/abstract-generator-cli/src/publishPackage.ts b/generators/typescript/utils/abstract-generator-cli/src/publishPackage.ts
@@ -8,13 +8,15 @@ export async function publishPackage({
     logger,
     npmPackage,
     dryRun,
-    typescriptProject
+    typescriptProject,
+    shouldTolerateRepublish
 }: {
     generatorNotificationService: GeneratorNotificationService | undefined;
     logger: Logger;
     npmPackage: NpmPackage | undefined;
     dryRun: boolean;
     typescriptProject: PersistedTypescriptProject;
+    shouldTolerateRepublish: boolean;
 }): Promise<void> {
     if (npmPackage?.publishInfo == null) {
         throw new Error("npmPackage.publishInfo is not defined.");
@@ -30,7 +32,8 @@ export async function publishPackage({
     await typescriptProject.publish({
         logger,
         dryRun,
-        publishInfo: npmPackage.publishInfo
+        publishInfo: npmPackage.publishInfo,
+        shouldTolerateRepublish
     });
 
     await generatorNotificationService?.sendUpdate(FernGeneratorExec.GeneratorUpdate.published(packageCoordinate));

diff --git a/generators/typescript/utils/commons/src/typescript-project/PersistedTypescriptProject.ts b/generators/typescript/utils/commons/src/typescript-project/PersistedTypescriptProject.ts
@@ -183,11 +183,13 @@ export class PersistedTypescriptProject {
     public async publish({
         logger,
         publishInfo,
-        dryRun
+        dryRun,
+        shouldTolerateRepublish
     }: {
         logger: Logger;
         publishInfo: PublishInfo;
         dryRun: boolean;
+        shouldTolerateRepublish: boolean;
     }): Promise<void> {
         await this.build(logger);
 
@@ -212,6 +214,9 @@ export class PersistedTypescriptProject {
         if (dryRun) {
             publishCommand.push("--dry-run");
         }
+        if (shouldTolerateRepublish) {
+            publishCommand.push("--tolerate-republish");
+        }
         await npm(publishCommand);
     }