(feature): Add allowExtraFields configuration to TypeScript generators (

#3368)
fern-api · Apr 15, 2024 · fcdb463 · fcdb463
1 parent 4879ae3
commit fcdb463
Show file tree

Hide file tree

Showing 702 changed files with 127,840 additions and 62 deletions.
diff --git a/.yarn/cache/@fern-api-fdr-sdk-npm-0.73.2-7a2b8d739-42a194888d-dbefed4a21.zip b/.yarn/cache/@fern-api-fdr-sdk-npm-0.73.2-7a2b8d739-42a194888d-dbefed4a21.zip
diff --git a/.yarn/cache/@fern-fern-generator-exec-sdk-npm-0.0.730-eba7b125e9-c870d1a5a5.zip b/.yarn/cache/@fern-fern-generator-exec-sdk-npm-0.0.730-eba7b125e9-c870d1a5a5.zip
diff --git a/generators/typescript/express/CHANGELOG.md b/generators/typescript/express/CHANGELOG.md
@@ -5,6 +5,18 @@ 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.11.0-rc0] - 2024-04-12
+
+- Feature: Add `allowExtraFields` option to permit extra fields in the returned response.
+
+  ```yaml
+  - name: fernapi/fern-typscript-express
+    version: 0.11.0-rc0
+    ...
+    config:
+      allowExtraFields: true
+  ```
+
 ## [0.10.0] - 2024-04-09
 
 - Support V37 of the IR.

diff --git a/generators/typescript/express/VERSION b/generators/typescript/express/VERSION
@@ -1 +1 @@
-0.10.0
+0.11.0-rc0
diff --git a/generators/typescript/express/cli/src/ExpressGeneratorCli.ts b/generators/typescript/express/cli/src/ExpressGeneratorCli.ts
@@ -22,7 +22,8 @@ export class ExpressGeneratorCli extends AbstractGeneratorCli<ExpressCustomConfi
             noSerdeLayer,
             outputEsm: parsed?.outputEsm ?? false,
             outputSourceFiles: parsed?.outputSourceFiles ?? false,
-            retainOriginalCasing: parsed?.retainOriginalCasing ?? false
+            retainOriginalCasing: parsed?.retainOriginalCasing ?? false,
+            allowExtraFields: parsed?.allowExtraFields ?? false
         };
     }
 
@@ -55,7 +56,8 @@ export class ExpressGeneratorCli extends AbstractGeneratorCli<ExpressCustomConfi
                 treatUnknownAsAny: customConfig.treatUnknownAsAny,
                 includeSerdeLayer: !customConfig.noSerdeLayer,
                 outputEsm: customConfig.outputEsm,
-                retainOriginalCasing: customConfig.retainOriginalCasing
+                retainOriginalCasing: customConfig.retainOriginalCasing,
+                allowExtraFields: customConfig.allowExtraFields
             }
         });
 

diff --git a/generators/typescript/express/cli/src/custom-config/ExpressCustomConfig.ts b/generators/typescript/express/cli/src/custom-config/ExpressCustomConfig.ts
@@ -11,4 +11,5 @@ export interface ExpressCustomConfig {
     outputEsm: boolean;
     outputSourceFiles: boolean;
     retainOriginalCasing: boolean;
+    allowExtraFields: boolean;
 }
diff --git a/generators/typescript/express/cli/src/custom-config/schema/ExpressCustomConfigSchema.ts b/generators/typescript/express/cli/src/custom-config/schema/ExpressCustomConfigSchema.ts
@@ -11,7 +11,8 @@ export const ExpressCustomConfigSchema = z.strictObject({
     outputSourceFiles: z.optional(z.boolean()),
     includeUtilsOnUnionMembers: z.optional(z.boolean()),
     includeOtherInUnionTypes: z.optional(z.boolean()),
-    retainOriginalCasing: z.optional(z.boolean())
+    retainOriginalCasing: z.optional(z.boolean()),
+    allowExtraFields: z.optional(z.boolean())
 });
 
 export type ExpressCustomConfigSchema = z.infer<typeof ExpressCustomConfigSchema>;
diff --git a/...xpress/express-endpoint-type-schemas-generator/src/ExpressEndpointTypeSchemasGenerator.ts b/...xpress/express-endpoint-type-schemas-generator/src/ExpressEndpointTypeSchemasGenerator.ts
@@ -6,6 +6,7 @@ import { GeneratedExpressEndpointTypeSchemasImpl } from "./GeneratedExpressEndpo
 export declare namespace ExpressEndpointTypeSchemasGenerator {
     export interface Init {
         includeSerdeLayer: boolean;
+        allowExtraFields: boolean;
     }
 
     export namespace generateEndpointTypeSchemas {
@@ -19,9 +20,11 @@ export declare namespace ExpressEndpointTypeSchemasGenerator {
 
 export class ExpressEndpointTypeSchemasGenerator {
     private includeSerdeLayer: boolean;
+    private allowExtraFields: boolean;
 
-    constructor({ includeSerdeLayer }: ExpressEndpointTypeSchemasGenerator.Init) {
+    constructor({ includeSerdeLayer, allowExtraFields }: ExpressEndpointTypeSchemasGenerator.Init) {
         this.includeSerdeLayer = includeSerdeLayer;
+        this.allowExtraFields = allowExtraFields;
     }
 
     public generateEndpointTypeSchemas({
@@ -33,7 +36,8 @@ export class ExpressEndpointTypeSchemasGenerator {
             packageId,
             service,
             endpoint,
-            includeSerdeLayer: this.includeSerdeLayer
+            includeSerdeLayer: this.includeSerdeLayer,
+            allowExtraFields: this.allowExtraFields
         });
     }
 }
diff --git a/...ss/express-endpoint-type-schemas-generator/src/GeneratedExpressEndpointTypeSchemasImpl.ts b/...ss/express-endpoint-type-schemas-generator/src/GeneratedExpressEndpointTypeSchemasImpl.ts
@@ -1,6 +1,6 @@
 import { assertNever } from "@fern-api/core-utils";
 import { HttpEndpoint, HttpService } from "@fern-fern/ir-sdk/api";
-import { PackageId } from "@fern-typescript/commons";
+import { getSchemaOptions, PackageId } from "@fern-typescript/commons";
 import { ExpressContext, GeneratedExpressEndpointTypeSchemas } from "@fern-typescript/contexts";
 import { ts } from "ts-morph";
 import { GeneratedEndpointTypeSchema } from "./GeneratedEndpointTypeSchema";
@@ -12,6 +12,7 @@ export declare namespace GeneratedExpressEndpointTypeSchemasImpl {
         service: HttpService;
         endpoint: HttpEndpoint;
         includeSerdeLayer: boolean;
+        allowExtraFields: boolean;
     }
 }
 
@@ -23,10 +24,18 @@ export class GeneratedExpressEndpointTypeSchemasImpl implements GeneratedExpress
     private generatedRequestSchema: GeneratedEndpointTypeSchema | undefined;
     private generatedResponseSchema: GeneratedEndpointTypeSchemaImpl | undefined;
     private includeSerdeLayer: boolean;
-
-    constructor({ packageId, service, endpoint, includeSerdeLayer }: GeneratedExpressEndpointTypeSchemasImpl.Init) {
+    private allowExtraFields: boolean;
+
+    constructor({
+        packageId,
+        service,
+        endpoint,
+        includeSerdeLayer,
+        allowExtraFields
+    }: GeneratedExpressEndpointTypeSchemasImpl.Init) {
         this.endpoint = endpoint;
         this.includeSerdeLayer = includeSerdeLayer;
+        this.allowExtraFields = allowExtraFields;
 
         if (includeSerdeLayer) {
             // only generate request schemas for referenced request bodies.  inlined
@@ -162,11 +171,9 @@ export class GeneratedExpressEndpointTypeSchemasImpl implements GeneratedExpress
                 return context.typeSchema
                     .getSchemaOfNamedType(this.endpoint.response.value.responseBodyType, { isGeneratingSchema: false })
                     .jsonOrThrow(referenceToParsedResponse, {
-                        unrecognizedObjectKeys: "strip",
-                        allowUnrecognizedEnumValues: false,
-                        allowUnrecognizedUnionMembers: false,
-                        skipValidation: false,
-                        breadcrumbsPrefix: []
+                        ...getSchemaOptions({
+                            allowExtraFields: this.allowExtraFields
+                        })
                     });
             case "primitive":
             case "container":
@@ -176,11 +183,9 @@ export class GeneratedExpressEndpointTypeSchemasImpl implements GeneratedExpress
                 return this.generatedResponseSchema
                     .getReferenceToZurgSchema(context)
                     .jsonOrThrow(referenceToParsedResponse, {
-                        unrecognizedObjectKeys: "strip",
-                        allowUnrecognizedEnumValues: false,
-                        allowUnrecognizedUnionMembers: false,
-                        skipValidation: false,
-                        breadcrumbsPrefix: []
+                        ...getSchemaOptions({
+                            allowExtraFields: this.allowExtraFields
+                        })
                     });
             default:
                 assertNever(this.endpoint.response.value.responseBodyType);

diff --git a/...tors/typescript/express/express-error-schema-generator/src/ExpressErrorSchemaGenerator.ts b/...tors/typescript/express/express-error-schema-generator/src/ExpressErrorSchemaGenerator.ts
@@ -5,6 +5,7 @@ import { GeneratedExpressErrorSchemaImpl } from "./GeneratedExpressErrorSchemaIm
 export declare namespace ExpressErrorSchemaGenerator {
     export interface Init {
         includeSerdeLayer: boolean;
+        allowExtraFields: boolean;
     }
 
     export namespace generateError {
@@ -17,9 +18,11 @@ export declare namespace ExpressErrorSchemaGenerator {
 
 export class ExpressErrorSchemaGenerator {
     private includeSerdeLayer: boolean;
+    private allowExtraFields: boolean;
 
-    constructor({ includeSerdeLayer }: ExpressErrorSchemaGenerator.Init) {
+    constructor({ includeSerdeLayer, allowExtraFields }: ExpressErrorSchemaGenerator.Init) {
         this.includeSerdeLayer = includeSerdeLayer;
+        this.allowExtraFields = allowExtraFields;
     }
 
     public generateExpressErrorSchema({
@@ -33,7 +36,8 @@ export class ExpressErrorSchemaGenerator {
             errorDeclaration,
             type: errorDeclaration.type,
             errorName,
-            includeSerdeLayer: this.includeSerdeLayer
+            includeSerdeLayer: this.includeSerdeLayer,
+            allowExtraFields: this.allowExtraFields
         });
     }
 }
diff --git a/.../typescript/express/express-error-schema-generator/src/GeneratedExpressErrorSchemaImpl.ts b/.../typescript/express/express-error-schema-generator/src/GeneratedExpressErrorSchemaImpl.ts
@@ -1,7 +1,7 @@
 import { assertNever } from "@fern-api/core-utils";
 import { ErrorDeclaration, TypeReference } from "@fern-fern/ir-sdk/api";
 import { AbstractGeneratedSchema } from "@fern-typescript/abstract-schema-generator";
-import { getTextOfTsNode, Reference, Zurg } from "@fern-typescript/commons";
+import { getSchemaOptions, getTextOfTsNode, Reference, Zurg } from "@fern-typescript/commons";
 import { ExpressContext, GeneratedExpressErrorSchema } from "@fern-typescript/contexts";
 import { ModuleDeclaration, ts } from "ts-morph";
 
@@ -11,6 +11,7 @@ export declare namespace GeneratedExpressErrorSchemaImpl {
         errorDeclaration: ErrorDeclaration;
         type: TypeReference;
         includeSerdeLayer: boolean;
+        allowExtraFields: boolean;
     }
 }
 
@@ -21,12 +22,20 @@ export class GeneratedExpressErrorSchemaImpl
     private errorDeclaration: ErrorDeclaration;
     private type: TypeReference;
     private includeSerdeLayer: boolean;
+    private allowExtraFields: boolean;
 
-    constructor({ errorName, errorDeclaration, type, includeSerdeLayer }: GeneratedExpressErrorSchemaImpl.Init) {
+    constructor({
+        errorName,
+        errorDeclaration,
+        type,
+        includeSerdeLayer,
+        allowExtraFields
+    }: GeneratedExpressErrorSchemaImpl.Init) {
         super({ typeName: errorName });
         this.errorDeclaration = errorDeclaration;
         this.type = type;
         this.includeSerdeLayer = includeSerdeLayer;
+        this.allowExtraFields = allowExtraFields;
     }
 
     public writeToFile(context: ExpressContext): void {
@@ -62,22 +71,18 @@ export class GeneratedExpressErrorSchemaImpl
                 return context.typeSchema
                     .getSchemaOfNamedType(this.type, { isGeneratingSchema: false })
                     .jsonOrThrow(referenceToBody, {
-                        allowUnrecognizedEnumValues: false,
-                        allowUnrecognizedUnionMembers: false,
-                        unrecognizedObjectKeys: "strip",
-                        skipValidation: false,
-                        breadcrumbsPrefix: []
+                        ...getSchemaOptions({
+                            allowExtraFields: this.allowExtraFields
+                        })
                     });
             case "unknown":
                 return referenceToBody;
             case "primitive":
             case "container":
                 return this.getReferenceToZurgSchema(context).jsonOrThrow(referenceToBody, {
-                    allowUnrecognizedEnumValues: false,
-                    allowUnrecognizedUnionMembers: false,
-                    unrecognizedObjectKeys: "strip",
-                    skipValidation: false,
-                    breadcrumbsPrefix: []
+                    ...getSchemaOptions({
+                        allowExtraFields: this.allowExtraFields
+                    })
                 });
             default:
                 assertNever(this.type);

diff --git a/generators/typescript/express/generator/src/ExpressGenerator.ts b/generators/typescript/express/generator/src/ExpressGenerator.ts
@@ -60,6 +60,7 @@ export declare namespace ExpressGenerator {
         includeSerdeLayer: boolean;
         outputEsm: boolean;
         retainOriginalCasing: boolean;
+        allowExtraFields: boolean;
     }
 }
 
@@ -194,7 +195,8 @@ export class ExpressGenerator {
             includeSerdeLayer: config.includeSerdeLayer
         });
         this.expressEndpointTypeSchemasGenerator = new ExpressEndpointTypeSchemasGenerator({
-            includeSerdeLayer: config.includeSerdeLayer
+            includeSerdeLayer: config.includeSerdeLayer,
+            allowExtraFields: config.allowExtraFields
         });
         this.expressServiceGenerator = new ExpressServiceGenerator({
             packageResolver: this.packageResolver,
@@ -210,7 +212,8 @@ export class ExpressGenerator {
         this.genericApiExpressErrorGenerator = new GenericAPIExpressErrorGenerator();
         this.expressErrorGenerator = new ExpressErrorGenerator();
         this.expressErrorSchemaGenerator = new ExpressErrorSchemaGenerator({
-            includeSerdeLayer: config.includeSerdeLayer
+            includeSerdeLayer: config.includeSerdeLayer,
+            allowExtraFields: config.allowExtraFields
         });
     }
 

diff --git a/generators/typescript/sdk/CHANGELOG.md b/generators/typescript/sdk/CHANGELOG.md
@@ -5,6 +5,18 @@ 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.14.0-rc0] - 2024-04-12
+
+- Feature: Add `allowExtraFields` option to permit extra fields in the serialized request.
+
+  ```yaml
+  - name: fernapi/fern-typscript-node-sdk
+    version: 0.14.0-rc0
+    ...
+    config:
+      allowExtraFields: true
+  ```
+
 ## [0.13.0] - 2024-04-09
 
 - Support V37 of the IR.

diff --git a/generators/typescript/sdk/VERSION b/generators/typescript/sdk/VERSION
@@ -1 +1 @@
-0.13.0
+0.14.0-rc0
diff --git a/generators/typescript/sdk/cli/src/SdkGeneratorCli.ts b/generators/typescript/sdk/cli/src/SdkGeneratorCli.ts
@@ -49,7 +49,8 @@ export class SdkGeneratorCli extends AbstractGeneratorCli<SdkCustomConfig> {
             noOptionalProperties: parsed?.noOptionalProperties ?? false,
             includeApiReference: parsed?.includeApiReference ?? false,
             tolerateRepublish: parsed?.tolerateRepublish ?? false,
-            retainOriginalCasing: parsed?.retainOriginalCasing ?? false
+            retainOriginalCasing: parsed?.retainOriginalCasing ?? false,
+            allowExtraFields: parsed?.allowExtraFields ?? false
         };
     }
 
@@ -103,7 +104,8 @@ export class SdkGeneratorCli extends AbstractGeneratorCli<SdkCustomConfig> {
                 retainOriginalCasing: customConfig.retainOriginalCasing ?? false,
                 noOptionalProperties: customConfig.noOptionalProperties,
                 includeApiReference: customConfig.includeApiReference ?? false,
-                tolerateRepublish: customConfig.tolerateRepublish
+                tolerateRepublish: customConfig.tolerateRepublish,
+                allowExtraFields: customConfig.allowExtraFields ?? false
             }
         });
         const typescriptProject = await sdkGenerator.generate();

diff --git a/generators/typescript/sdk/cli/src/custom-config/SdkCustomConfig.ts b/generators/typescript/sdk/cli/src/custom-config/SdkCustomConfig.ts
@@ -24,4 +24,5 @@ export interface SdkCustomConfig {
     includeApiReference: boolean | undefined;
     tolerateRepublish: boolean;
     retainOriginalCasing: boolean | undefined;
+    allowExtraFields: boolean | undefined;
 }
diff --git a/generators/typescript/sdk/cli/src/custom-config/schema/SdkCustomConfigSchema.ts b/generators/typescript/sdk/cli/src/custom-config/schema/SdkCustomConfigSchema.ts
@@ -26,6 +26,7 @@ export const SdkCustomConfigSchema = z.strictObject({
     includeOtherInUnionTypes: z.optional(z.boolean()),
     includeApiReference: z.optional(z.boolean()),
     retainOriginalCasing: z.optional(z.boolean()),
+    allowExtraFields: z.optional(z.boolean()),
 
     // deprecated
     timeoutInSeconds: z.optional(z.union([z.literal("infinity"), z.number()]))

diff --git a/generators/typescript/sdk/generator/src/SdkGenerator.ts b/generators/typescript/sdk/generator/src/SdkGenerator.ts
@@ -93,6 +93,7 @@ export declare namespace SdkGenerator {
         includeApiReference: boolean;
         tolerateRepublish: boolean;
         retainOriginalCasing: boolean;
+        allowExtraFields: boolean;
     }
 }
 
@@ -271,7 +272,8 @@ export class SdkGenerator {
             intermediateRepresentation,
             shouldGenerateErrors: config.neverThrowErrors,
             skipResponseValidation: config.skipResponseValidation,
-            includeSerdeLayer: config.includeSerdeLayer
+            includeSerdeLayer: config.includeSerdeLayer,
+            allowExtraFields: config.allowExtraFields
         });
         this.requestWrapperGenerator = new RequestWrapperGenerator();
         this.environmentsGenerator = new EnvironmentsGenerator();
@@ -293,7 +295,8 @@ export class SdkGenerator {
         this.genericAPISdkErrorGenerator = new GenericAPISdkErrorGenerator();
         this.timeoutSdkErrorGenerator = new TimeoutSdkErrorGenerator();
         this.sdkInlinedRequestBodySchemaGenerator = new SdkInlinedRequestBodySchemaGenerator({
-            includeSerdeLayer: config.includeSerdeLayer
+            includeSerdeLayer: config.includeSerdeLayer,
+            allowExtraFields: config.allowExtraFields
         });
         this.jestTestGenerator = new JestTestGenerator(
             intermediateRepresentation,

diff --git a/generators/typescript/sdk/generator/src/__test__/__mocks__/Mocks.ts b/generators/typescript/sdk/generator/src/__test__/__mocks__/Mocks.ts
@@ -54,6 +54,7 @@ export const Mocks = {
             includeApiReference: false,
             tolerateRepublish: false,
             retainOriginalCasing: false,
+            allowExtraFields: false,
             ...partialConfig
         };
     }