fern-api 0.29.3 → 0.29.5

package/bundle.cjs

@@ -363202,6 +363202,12 @@ var init_GlobalHeader = __esm({
   }
 });
 
+// pnp:/home/circleci/project/packages/cli/openapi-ir-sdk/lib/sdk/api/resources/finalIr/types/IdempotencyHeader.js
+var init_IdempotencyHeader = __esm({
+  "pnp:/home/circleci/project/packages/cli/openapi-ir-sdk/lib/sdk/api/resources/finalIr/types/IdempotencyHeader.js"() {
+  }
+});
+
 // pnp:/home/circleci/project/packages/cli/openapi-ir-sdk/lib/sdk/api/resources/finalIr/types/Tags.js
 var init_Tags = __esm({
   "pnp:/home/circleci/project/packages/cli/openapi-ir-sdk/lib/sdk/api/resources/finalIr/types/Tags.js"() {
@@ -364242,6 +364248,7 @@ var init_types28 = __esm({
     init_OpenApiIntermediateRepresentation();
     init_SdkGroupInfo();
     init_GlobalHeader();
+    init_IdempotencyHeader();
     init_Tags();
     init_HttpError();
     init_Webhook3();
@@ -366990,7 +366997,8 @@ var init_OpenApiIntermediateRepresentation2 = __esm({
       variables: schemas_exports5.record(schemas_exports5.string(), schemas_exports5.lazyObject(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).PrimitiveSchema)),
       nonRequestReferencedSchemas: schemas_exports5.set(schemas_exports5.lazy(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).SchemaId)),
       securitySchemes: schemas_exports5.record(schemas_exports5.lazy(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).SecuritySchemeId), schemas_exports5.lazy(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).SecurityScheme)),
-      globalHeaders: schemas_exports5.list(schemas_exports5.lazyObject(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).GlobalHeader)).optional()
+      globalHeaders: schemas_exports5.list(schemas_exports5.lazyObject(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).GlobalHeader)).optional(),
+      idempotencyHeaders: schemas_exports5.list(schemas_exports5.lazyObject(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).IdempotencyHeader)).optional()
     });
   }
 });
@@ -367022,6 +367030,20 @@ var init_GlobalHeader2 = __esm({
   }
 });
 
+// pnp:/home/circleci/project/packages/cli/openapi-ir-sdk/lib/sdk/serialization/resources/finalIr/types/IdempotencyHeader.js
+var IdempotencyHeader;
+var init_IdempotencyHeader2 = __esm({
+  "pnp:/home/circleci/project/packages/cli/openapi-ir-sdk/lib/sdk/serialization/resources/finalIr/types/IdempotencyHeader.js"() {
+    init_core3();
+    IdempotencyHeader = schemas_exports5.objectWithoutOptionalProperties({
+      header: schemas_exports5.string(),
+      name: schemas_exports5.string().optional(),
+      env: schemas_exports5.string().optional(),
+      schema: schemas_exports5.lazy(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).Schema).optional()
+    });
+  }
+});
+
 // pnp:/home/circleci/project/packages/cli/openapi-ir-sdk/lib/sdk/serialization/resources/finalIr/types/Tags.js
 var Tags;
 var init_Tags2 = __esm({
@@ -367146,6 +367168,7 @@ var init_Endpoint2 = __esm({
     Endpoint = schemas_exports5.objectWithoutOptionalProperties({
       authed: schemas_exports5.boolean(),
       internal: schemas_exports5.boolean().optional(),
+      idempotent: schemas_exports5.boolean().optional(),
       method: schemas_exports5.lazy(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).HttpMethod),
       availability: schemas_exports5.lazy(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).EndpointAvailability).optional(),
       audiences: schemas_exports5.list(schemas_exports5.string()),
@@ -368053,6 +368076,7 @@ var init_types32 = __esm({
     init_OpenApiIntermediateRepresentation2();
     init_SdkGroupInfo2();
     init_GlobalHeader2();
+    init_IdempotencyHeader2();
     init_Tags2();
     init_HttpError2();
     init_Webhook4();
@@ -368149,6 +368173,7 @@ __export(finalIr_exports2, {
   HeaderExample: () => HeaderExample,
   HttpError: () => HttpError,
   HttpMethod: () => HttpMethod6,
+  IdempotencyHeader: () => IdempotencyHeader,
   IntSchema: () => IntSchema,
   JsonRequest: () => JsonRequest,
   JsonResponse: () => JsonResponse3,
@@ -368229,6 +368254,7 @@ var init_EndpointWithExample2 = __esm({
     EndpointWithExample = schemas_exports5.objectWithoutOptionalProperties({
       authed: schemas_exports5.boolean(),
       internal: schemas_exports5.boolean().optional(),
+      idempotent: schemas_exports5.boolean().optional(),
       method: schemas_exports5.lazy(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).HttpMethod),
       availability: schemas_exports5.lazy(async () => (await Promise.resolve().then(() => (init_serialization3(), serialization_exports3))).EndpointAvailability).optional(),
       audiences: schemas_exports5.list(schemas_exports5.string()),
@@ -368934,6 +368960,7 @@ __export(serialization_exports3, {
   HttpError: () => HttpError,
   HttpErrorWithExample: () => HttpErrorWithExample,
   HttpMethod: () => HttpMethod6,
+  IdempotencyHeader: () => IdempotencyHeader,
   Int64WithExample: () => Int64WithExample,
   IntSchema: () => IntSchema,
   IntWithExample: () => IntWithExample,
@@ -1012978,7 +1013005,7 @@ var AccessTokenPosthogManager = class {
         properties: {
           ...event,
           ...event.properties,
-          version: "0.29.3",
+          version: "0.29.5",
           usingAccessToken: true
         }
       });
@@ -1013040,7 +1013067,7 @@ var UserPosthogManager = class {
       distinctId: this.userId ?? await this.getPersistedDistinctId(),
       event: "CLI",
       properties: {
-        version: "0.29.3",
+        version: "0.29.5",
         ...event,
         ...event.properties
       }
@@ -1018243,6 +1018270,8 @@ var FernOpenAPIExtension = {
   FERN_HEADER_AUTH: "x-fern-header",
   FERN_BASIC_AUTH: "x-fern-basic",
   FERN_GLOBAL_HEADERS: "x-fern-global-headers",
+  FERN_IDEMPOTENCY_HEADERS: "x-fern-idempotency-headers",
+  IDEMPOTENT: "x-fern-idempotent",
   FERN_PROPERTY_NAME: "x-fern-property-name"
 };
 
@@ -1020090,9 +1020119,11 @@ function convertSchemaObject(schema2, wrapAsNullable, context, breadcrumbs, prop
       const [firstSchema, secondSchema] = schema2.anyOf;
       if (firstSchema != null && secondSchema != null) {
         if (!isReferenceObject(firstSchema) && firstSchema.type === "null") {
-          return convertSchema(secondSchema, true, context, breadcrumbs);
+          const convertedSchema = convertSchema(secondSchema, true, context, breadcrumbs);
+          return maybeInjectDescriptionOrGroupName(convertedSchema, description, groupName);
         } else if (!isReferenceObject(secondSchema) && secondSchema.type === "null") {
-          return convertSchema(firstSchema, true, context, breadcrumbs);
+          const convertedSchema = convertSchema(firstSchema, true, context, breadcrumbs);
+          return maybeInjectDescriptionOrGroupName(convertedSchema, description, groupName);
         }
       }
     }
@@ -1020244,23 +1020275,19 @@ function maybeInjectDescriptionOrGroupName(schema2, description, groupName) {
       description,
       groupName
     });
-  } else if (schema2.type === "optional" && schema2.value.type === "reference") {
+  } else if (schema2.type === "optional") {
     return SchemaWithExample.optional({
       nameOverride: schema2.nameOverride,
       generatedName: schema2.generatedName,
-      value: SchemaWithExample.reference({
-        ...schema2.value
-      }),
+      value: schema2.value,
       description,
       groupName
     });
-  } else if (schema2.type === "nullable" && schema2.value.type === "reference") {
+  } else if (schema2.type === "nullable") {
     return SchemaWithExample.nullable({
       nameOverride: schema2.nameOverride,
       generatedName: schema2.generatedName,
-      value: SchemaWithExample.reference({
-        ...schema2.value
-      }),
+      value: schema2.value,
       description,
       groupName
     });
@@ -1023142,6 +1023169,7 @@ function markErrorSchemas({ responses, context }) {
 // pnp:/home/circleci/project/packages/cli/openapi-parser/lib/openapi/v3/converters/operation/convertHttpOperation.js
 function convertHttpOperation({ operationContext, context, responseStatusCode, suffix, streamFormat }) {
   const { document: document6, operation, path: path42, method: method2, baseBreadcrumbs, sdkMethodName } = operationContext;
+  const idempotent = getExtension(operation, FernOpenAPIExtension.IDEMPOTENT);
   const requestNameOverride = getExtension(operation, [
     FernOpenAPIExtension.REQUEST_NAME_V1,
     FernOpenAPIExtension.REQUEST_NAME_V2
@@ -1023192,6 +1023220,7 @@ function convertHttpOperation({ operationContext, context, responseStatusCode, s
   return {
     summary: operation.summary,
     internal: getExtension(operation, OpenAPIExtension.INTERNAL),
+    idempotent,
     audiences: getExtension(operation, FernOpenAPIExtension.AUDIENCES) ?? [],
     operationId: operation.operationId != null && suffix != null ? operation.operationId + "_" + suffix : operation.operationId,
     tags: operation.tags ?? [],
@@ -1023766,6 +1023795,25 @@ function getGlobalHeaders(document6) {
   return result2;
 }
 
+// pnp:/home/circleci/project/packages/cli/openapi-parser/lib/openapi/v3/extensions/getIdempotencyHeaders.js
+function getIdempotencyHeaders(document6) {
+  const idempotencyHeaders = getExtension(document6, FernOpenAPIExtension.FERN_IDEMPOTENCY_HEADERS);
+  const result2 = [];
+  for (const header of idempotencyHeaders ?? []) {
+    result2.push({
+      ...header,
+      schema: header.type != null ? getSchemaFromFernType({
+        fernType: header.type,
+        description: void 0,
+        generatedName: header.name ?? header.header,
+        groupName: void 0,
+        nameOverride: void 0
+      }) : void 0
+    });
+  }
+  return result2;
+}
+
 // pnp:/home/circleci/project/packages/cli/openapi-parser/lib/openapi/v3/extensions/getVariableDefinitions.js
 function getVariableDefinitions(document6) {
   const variables = getExtension(document6, FernOpenAPIExtension.SDK_VARIABLES);
@@ -1023949,6 +1023997,7 @@ function generateIr({ openApi, taskContext, disableExamples, audiences, shouldUs
   const context = new OpenAPIV3ParserContext({ document: openApi, taskContext, authHeaders, shouldUseTitleAsName });
   const variables = getVariableDefinitions(openApi);
   const globalHeaders = getGlobalHeaders(openApi);
+  const idempotencyHeaders = getIdempotencyHeaders(openApi);
   const endpointsWithExample = [];
   const webhooks = [];
   Object.entries(openApi.paths).forEach(([path42, pathItem]) => {
@@ -1024110,7 +1024159,8 @@ function generateIr({ openApi, taskContext, disableExamples, audiences, shouldUs
     hasEndpointsMarkedInternal: endpoints.some((endpoint) => endpoint.internal),
     nonRequestReferencedSchemas: context.getReferencedSchemas(),
     variables,
-    globalHeaders
+    globalHeaders,
+    idempotencyHeaders
   };
   return ir;
 }
@@ -1024224,6 +1024274,7 @@ async function parse3({ workspace, taskContext }) {
     nonRequestReferencedSchemas: /* @__PURE__ */ new Set(),
     securitySchemes: {},
     globalHeaders: [],
+    idempotencyHeaders: [],
     groups: {}
   };
   for (const spec of workspace.specs) {
@@ -1024310,6 +1024361,7 @@ function merge3(ir1, ir2) {
       ...ir2.securitySchemes
     },
     globalHeaders: ir1.globalHeaders != null ? [...ir1.globalHeaders, ...ir2.globalHeaders ?? []] : void 0,
+    idempotencyHeaders: ir1.idempotencyHeaders != null ? [...ir1.idempotencyHeaders, ...ir2.idempotencyHeaders ?? []] : void 0,
     groups: {
       ...ir1.groups,
       ...ir2.groups
@@ -1024921,6 +1024973,40 @@ function buildGlobalHeaders(context) {
   }
 }
 
+// pnp:/home/circleci/project/packages/cli/openapi-ir-to-fern/lib/buildIdempotencyHeaders.js
+var STRING_SCHEMA = Schema2.primitive({
+  description: void 0,
+  generatedName: "",
+  groupName: void 0,
+  nameOverride: void 0,
+  schema: PrimitiveSchemaValue.string({
+    default: void 0,
+    pattern: void 0,
+    format: void 0,
+    minLength: void 0,
+    maxLength: void 0
+  })
+});
+function buildIdempotencyHeaders(context) {
+  for (const header of context.ir.idempotencyHeaders ?? []) {
+    const convertedHeader = buildHeader({
+      header: {
+        ...header,
+        schema: header.schema ?? STRING_SCHEMA,
+        name: header.name ?? header.header,
+        parameterNameOverride: void 0,
+        description: void 0
+      },
+      fileContainingReference: RelativeFilePath.of(ROOT_API_FILENAME),
+      context
+    });
+    context.builder.addIdempotencyHeader({
+      name: header.header,
+      schema: wrapTypeReferenceAsOptional(convertedHeader)
+    });
+  }
+}
+
 // pnp:/home/circleci/project/packages/cli/openapi-ir-to-fern/lib/buildEndpointExample.js
 function buildEndpointExample({ endpointExample, context }) {
   const example = {};
@@ -1025279,6 +1025365,9 @@ function buildEndpoint({ endpoint, declarationFile, context }) {
       convertedEndpoint.url = serverOverride.name ?? void 0;
     }
   }
+  if (endpoint.idempotent) {
+    convertedEndpoint.idempotent = true;
+  }
   if (endpoint.availability === EndpointAvailability.Beta) {
     convertedEndpoint.availability = "pre-release";
   } else if (endpoint.availability === EndpointAvailability.GenerallyAvailable) {
@@ -1025782,6 +1025871,7 @@ var ERROR_DECLARATIONS_FILENAME = RelativeFilePath.of(FERN_PACKAGE_MARKER_FILENA
 function buildFernDefinition(context) {
   buildEnvironments(context);
   buildGlobalHeaders(context);
+  buildIdempotencyHeaders(context);
   buildAuthSchemes(context);
   buildVariables(context);
   if (context.ir.basePath != null) {
@@ -1025913,6 +1026003,12 @@ var FernDefinitionBuilderImpl = class {
     }
     this.rootApiFile.headers[name2] = schema2;
   }
+  addIdempotencyHeader({ name: name2, schema: schema2 }) {
+    if (this.rootApiFile["idempotency-headers"] == null) {
+      this.rootApiFile["idempotency-headers"] = {};
+    }
+    this.rootApiFile["idempotency-headers"][name2] = schema2;
+  }
   addVariable({ name: name2, schema: schema2 }) {
     if (this.rootApiFile.variables == null) {
       this.rootApiFile.variables = {};
@@ -1030395,10 +1030491,10 @@ var CliContext = class {
     return "fern-api";
   }
   getPackageVersion() {
-    if ("0.29.3" == null) {
+    if ("0.29.5" == null) {
       this.logger.error("CLI_VERSION is not defined");
     }
-    return "0.29.3";
+    return "0.29.5";
   }
   getCliName() {
     if ("fern" == null) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fern-api",
-  "version": "0.29.3",
+  "version": "0.29.5",
   "repository": {
     "type": "git",
     "url": "https://github.com/fern-api/fern.git",