fern-api 0.33.4 → 0.33.6-rc0

package/bundle.cjs

@@ -24404,7 +24404,8 @@ var init_ExperimentalConfig = __esm({
   "pnp:/home/runner/work/fern/fern/packages/cli/configuration/lib/docs-yml/schemas/sdk/serialization/resources/docs/types/ExperimentalConfig.js"() {
     init_core();
     ExperimentalConfig = schemas_exports.object({
-      mdxComponents: schemas_exports.property("mdx-components", schemas_exports.list(schemas_exports.string()).optional())
+      mdxComponents: schemas_exports.property("mdx-components", schemas_exports.list(schemas_exports.string()).optional()),
+      disableStreamToggle: schemas_exports.property("disable-stream-toggle", schemas_exports.boolean().optional())
     });
   }
 });
@@ -1164535,7 +1164536,7 @@ var AccessTokenPosthogManager = class {
         properties: {
           ...event,
           ...event.properties,
-          version: "0.33.4",
+          version: "0.33.6-rc0",
           usingAccessToken: true
         }
       });
@@ -1164597,7 +1164598,7 @@ var UserPosthogManager = class {
       distinctId: this.userId ?? await this.getPersistedDistinctId(),
       event: "CLI",
       properties: {
-        version: "0.33.4",
+        version: "0.33.6-rc0",
         ...event,
         ...event.properties
       }
@@ -1178828,7 +1178829,7 @@ function buildBooleanTypeReference({ description, schema: schema2 }) {
   return result2;
 }
 function buildLongTypeReference({ description, schema: schema2 }) {
-  const type2 = "int64";
+  const type2 = "long";
   if (description == null && schema2.default == null) {
     return type2;
   }
@@ -1181421,34 +1181422,54 @@ function getDefaultAsString(schema2) {
 }
 
 // pnp:/home/runner/work/fern/fern/packages/cli/openapi-parser/lib/schema/examples/getExample.js
-function getExampleAsNumber(schema2) {
+function getExampleAsNumber({ schema: schema2, logger, fallback: fallback2 }) {
   if (schema2.example != null && typeof schema2.example === "number") {
     return schema2.example;
   }
+  if (fallback2 && typeof fallback2 === "number") {
+    return fallback2;
+  } else if (fallback2) {
+    logger.warn(`Expected fallback to be a number, but got ${typeof fallback2}`);
+  }
   return void 0;
 }
-function getExampleAsBoolean(schema2) {
+function getExampleAsBoolean({ schema: schema2, logger, fallback: fallback2 }) {
   if (schema2.example != null && typeof schema2.example === "boolean") {
     return schema2.example;
   }
+  if (fallback2 && typeof fallback2 === "boolean") {
+    return fallback2;
+  } else if (fallback2) {
+    logger.warn(`Expected fallback to be a boolean, but got ${typeof fallback2}`);
+  }
   return void 0;
 }
-function getExamplesString(schema2) {
+function getExamplesString({ schema: schema2, logger, fallback: fallback2 }) {
   if (schema2.example != null && typeof schema2.example === "string") {
     return schema2.example;
   }
+  if (fallback2 && typeof fallback2 === "string") {
+    return fallback2;
+  } else if (fallback2) {
+    logger.warn(`Expected fallback to be a string, but got ${typeof fallback2}`);
+  }
   return void 0;
 }
-function getExampleAsArray(schema2) {
+function getExampleAsArray({ schema: schema2, logger, fallback: fallback2 }) {
   if (schema2.example != null && Array.isArray(schema2.example)) {
     return schema2.example;
   }
+  if (fallback2 && Array.isArray(fallback2)) {
+    return fallback2;
+  } else if (fallback2) {
+    logger.warn(`Expected fallback to be a array, but got ${typeof fallback2}`);
+  }
   return void 0;
 }
 
 // pnp:/home/runner/work/fern/fern/packages/cli/openapi-parser/lib/schema/convertSchemas.js
 var SCHEMA_REFERENCE_PREFIX = "#/components/schemas/";
-function convertSchema(schema2, wrapAsNullable, context, breadcrumbs, referencedAsRequest = false, propertiesToExclude = /* @__PURE__ */ new Set()) {
+function convertSchema(schema2, wrapAsNullable, context, breadcrumbs, referencedAsRequest = false, propertiesToExclude = /* @__PURE__ */ new Set(), fallback2) {
   if (isReferenceObject(schema2)) {
     const schemaId = getSchemaIdFromReference(schema2);
     if (schemaId != null) {
@@ -1181459,9 +1181480,9 @@ function convertSchema(schema2, wrapAsNullable, context, breadcrumbs, referenced
       }
       return convertReferenceObject(schema2, wrapAsNullable, context, breadcrumbs);
     }
-    return convertSchemaObject(context.resolveSchemaReference(schema2), wrapAsNullable, context, getBreadcrumbsFromReference(schema2.$ref), propertiesToExclude, referencedAsRequest);
+    return convertSchemaObject(context.resolveSchemaReference(schema2), wrapAsNullable, context, getBreadcrumbsFromReference(schema2.$ref), propertiesToExclude, referencedAsRequest, fallback2);
   } else {
-    return convertSchemaObject(schema2, wrapAsNullable, context, breadcrumbs, propertiesToExclude, referencedAsRequest);
+    return convertSchemaObject(schema2, wrapAsNullable, context, breadcrumbs, propertiesToExclude, referencedAsRequest, fallback2);
   }
 }
 function convertReferenceObject(schema2, wrapAsNullable, context, breadcrumbs) {
@@ -1181491,7 +1181512,7 @@ function getTitleAsName(title2) {
   }
   return title2;
 }
-function convertSchemaObject(schema2, wrapAsNullable, context, breadcrumbs, propertiesToExclude = /* @__PURE__ */ new Set(), referencedAsRequest = false) {
+function convertSchemaObject(schema2, wrapAsNullable, context, breadcrumbs, propertiesToExclude = /* @__PURE__ */ new Set(), referencedAsRequest = false, fallback2) {
   var _a5;
   const nameOverride = getExtension(schema2, FernOpenAPIExtension.TYPE_NAME) ?? (context.options.useTitlesAsName ? getTitleAsName(schema2.title) : void 0);
   const mixedGroupName = getExtension(schema2, FernOpenAPIExtension.SDK_GROUP_NAME) ?? ((_a5 = getExtension(schema2, OpenAPIExtension.TAGS)) == null ? void 0 : _a5[0]);
@@ -1181514,7 +1181535,7 @@ function convertSchemaObject(schema2, wrapAsNullable, context, breadcrumbs, prop
     return fernSchema;
   }
   if (!wrapAsNullable && schema2.nullable === true) {
-    return convertSchemaObject(schema2, true, context, breadcrumbs);
+    return convertSchemaObject(schema2, true, context, breadcrumbs, propertiesToExclude, referencedAsRequest, fallback2);
   }
   if (schema2.enum != null && (schema2.type === "string" || schema2.type == null)) {
     if (!isListOfStrings(schema2.enum)) {
@@ -1181527,7 +1181548,7 @@ function convertSchemaObject(schema2, wrapAsNullable, context, breadcrumbs, prop
           maxLength: schema2.maxLength,
           pattern: schema2.pattern,
           format: schema2.format,
-          example: getExamplesString(schema2)
+          example: getExamplesString({ schema: schema2, logger: context.logger, fallback: fallback2 })
         }),
         groupName,
         wrapAsNullable,
@@ -1181570,7 +1181591,7 @@ function convertSchemaObject(schema2, wrapAsNullable, context, breadcrumbs, prop
         value: convertSchemaObject({
           ...schema2,
           type: secondElement
-        }, wrapAsNullable, context, breadcrumbs, propertiesToExclude),
+        }, wrapAsNullable, context, breadcrumbs, propertiesToExclude, referencedAsRequest, fallback2),
         groupName,
         description: schema2.description,
         availability
@@ -1181582,7 +1181603,7 @@ function convertSchemaObject(schema2, wrapAsNullable, context, breadcrumbs, prop
         value: convertSchemaObject({
           ...schema2,
           type: firstElement
-        }, wrapAsNullable, context, breadcrumbs, propertiesToExclude),
+        }, wrapAsNullable, context, breadcrumbs, propertiesToExclude, referencedAsRequest, fallback2),
         groupName,
         description: schema2.description,
         availability
@@ -1181627,7 +1181648,7 @@ function convertSchemaObject(schema2, wrapAsNullable, context, breadcrumbs, prop
       generatedName,
       primitive: PrimitiveSchemaValueWithExample.boolean({
         default: schema2.default,
-        example: getExampleAsBoolean(schema2)
+        example: getExampleAsBoolean({ schema: schema2, logger: context.logger, fallback: fallback2 })
       }),
       wrapAsNullable,
       description,
@@ -1181649,7 +1181670,7 @@ function convertSchemaObject(schema2, wrapAsNullable, context, breadcrumbs, prop
       description,
       availability,
       wrapAsNullable,
-      example: getExampleAsNumber(schema2),
+      example: getExampleAsNumber({ schema: schema2, logger: context.logger, fallback: fallback2 }),
       groupName
     });
   }
@@ -1181664,7 +1181685,7 @@ function convertSchemaObject(schema2, wrapAsNullable, context, breadcrumbs, prop
         exclusiveMinimum: getValueIfBoolean(schema2.exclusiveMinimum),
         exclusiveMaximum: getValueIfBoolean(schema2.exclusiveMaximum),
         multipleOf: schema2.multipleOf,
-        example: getExampleAsNumber(schema2)
+        example: getExampleAsNumber({ schema: schema2, logger: context.logger, fallback: fallback2 })
       }),
       wrapAsNullable,
       description,
@@ -1181686,7 +1181707,7 @@ function convertSchemaObject(schema2, wrapAsNullable, context, breadcrumbs, prop
       description,
       availability,
       wrapAsNullable,
-      example: getExampleAsNumber(schema2),
+      example: getExampleAsNumber({ schema: schema2, logger: context.logger, fallback: fallback2 }),
       groupName
     });
   }
@@ -1181696,7 +1181717,7 @@ function convertSchemaObject(schema2, wrapAsNullable, context, breadcrumbs, prop
         nameOverride,
         generatedName,
         primitive: PrimitiveSchemaValueWithExample.datetime({
-          example: getExamplesString(schema2)
+          example: getExamplesString({ schema: schema2, logger: context.logger, fallback: fallback2 })
         }),
         wrapAsNullable,
         description,
@@ -1181734,7 +1181755,7 @@ function convertSchemaObject(schema2, wrapAsNullable, context, breadcrumbs, prop
         format: schema2.format,
         minLength: schema2.minLength,
         maxLength: schema2.maxLength,
-        example: getExamplesString(schema2)
+        example: getExamplesString({ schema: schema2, logger: context.logger, fallback: fallback2 })
       }),
       groupName,
       wrapAsNullable,
@@ -1181753,7 +1181774,7 @@ function convertSchemaObject(schema2, wrapAsNullable, context, breadcrumbs, prop
       wrapAsNullable,
       context,
       groupName,
-      example: getExampleAsArray(schema2)
+      example: getExampleAsArray({ schema: schema2, logger: context.logger, fallback: fallback2 })
     });
   }
   if (schema2.additionalProperties != null && schema2.additionalProperties !== false && hasNoProperties(schema2)) {
@@ -1182001,7 +1182022,7 @@ function convertSchemaObject(schema2, wrapAsNullable, context, breadcrumbs, prop
           format: schema2.format,
           minLength: schema2.minLength,
           maxLength: schema2.maxLength,
-          example: getExamplesString(schema2)
+          example: getExamplesString({ schema: schema2, logger: context.logger, fallback: fallback2 })
         }),
         groupName
       },
@@ -1184686,6 +1184707,7 @@ function getVariableReference(parameter) {
 
 // pnp:/home/runner/work/fern/fern/packages/cli/openapi-parser/lib/openapi/v3/converters/endpoint/convertParameters.js
 function convertParameters({ path: path44, httpMethod, parameters, context, requestBreadcrumbs }) {
+  var _a5;
   const convertedParameters = {
     pathParameters: [],
     queryParameters: [],
@@ -1184697,7 +1184719,13 @@ function convertParameters({ path: path44, httpMethod, parameters, context, requ
     const availability = convertAvailability3(resolvedParameter);
     const parameterBreadcrumbs = [...requestBreadcrumbs, resolvedParameter.name];
     const generatedName = getGeneratedTypeName(parameterBreadcrumbs);
-    let schema2 = resolvedParameter.schema != null ? convertSchema(resolvedParameter.schema, !isRequired, context, parameterBreadcrumbs) : isRequired ? SchemaWithExample.primitive({
+    if ((_a5 = getExamplesString({ schema: resolvedParameter, logger: context.logger })) == null ? void 0 : _a5.includes(" ")) {
+      context.logger.warn("Parameter example contains a space, which is ambiguous. Consider using enums for multiple examples, or use an encoding if a space is part of the parameter.");
+    }
+    let schema2 = resolvedParameter.schema != null ? convertSchema(resolvedParameter.schema, !isRequired, context, parameterBreadcrumbs, false, /* @__PURE__ */ new Set(), getExamplesString({
+      schema: resolvedParameter,
+      logger: context.logger
+    })) : isRequired ? SchemaWithExample.primitive({
       nameOverride: void 0,
       generatedName,
       schema: PrimitiveSchemaValueWithExample.string({
@@ -1184706,7 +1184734,10 @@ function convertParameters({ path: path44, httpMethod, parameters, context, requ
         format: void 0,
         minLength: void 0,
         maxLength: void 0,
-        example: getExamplesString(resolvedParameter.example)
+        example: getExamplesString({
+          schema: resolvedParameter,
+          logger: context.logger
+        })
       }),
       description: void 0,
       availability,
@@ -1184723,7 +1184754,10 @@ function convertParameters({ path: path44, httpMethod, parameters, context, requ
           format: void 0,
           minLength: void 0,
           maxLength: void 0,
-          example: getExamplesString(resolvedParameter.example)
+          example: getExamplesString({
+            schema: resolvedParameter,
+            logger: context.logger
+          })
         }),
         description: void 0,
         availability: void 0,
@@ -1187320,6 +1187354,9 @@ function convertPrimitive2(primitiveExample) {
     }
     case "datetime":
       try {
+        if (!primitiveExample.value.endsWith("Z") && !primitiveExample.value.includes("+")) {
+          primitiveExample.value += "Z";
+        }
         return new Date(primitiveExample.value).toISOString().replace(/\.\d{3}Z$/, "Z");
       } catch (e) {
         return "2024-01-15T09:30:00Z";
@@ -1192599,10 +1192636,10 @@ var CliContext = class {
     return "fern-api";
   }
   getPackageVersion() {
-    if ("0.33.4" == null) {
+    if ("0.33.6-rc0" == null) {
       this.logger.error("CLI_VERSION is not defined");
     }
-    return "0.33.4";
+    return "0.33.6-rc0";
   }
   getCliName() {
     if ("fern" == null) {
@@ -1200719,11 +1200756,14 @@ var ApiReferenceNodeConverter = class {
     __privateAdd(this, _children, []);
     __privateAdd(this, _overviewPageId, void 0);
     __privateAdd(this, _slug, void 0);
+    __publicField(this, "disableEndpointPairs");
+    var _a5;
     this.apiSection = apiSection;
     this.workspace = workspace;
     this.docsWorkspace = docsWorkspace;
     this.taskContext = taskContext;
     this.markdownFilesToFullSlugs = markdownFilesToFullSlugs;
+    this.disableEndpointPairs = ((_a5 = docsWorkspace.config.experimental) == null ? void 0 : _a5.disableStreamToggle) ?? false;
     this.apiDefinitionId = navigation_exports2.ApiDefinitionId(api.id);
     __privateSet(this, _holder2, ApiDefinitionHolder2.create(api, taskContext));
     const idgen = NodeIdGenerator2.init(this.apiDefinitionId);
@@ -1200764,6 +1200804,9 @@ var ApiReferenceNodeConverter = class {
     };
   }
   mergeEndpointPairs(children2) {
+    if (this.disableEndpointPairs) {
+      return children2;
+    }
     const toRet = [];
     const methodAndPathToEndpointNode = /* @__PURE__ */ new Map();
     children2.forEach((child) => {

package/package.json

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