fern-api 0.37.15 → 0.37.16

package/bundle.cjs

@@ -1214480,7 +1214480,8 @@ var import_path11 = __toESM(require("path"));
 var APIDefinitionPathSchema = z.string().describe("Path to the OpenAPI, AsyncAPI or Fern Definition");
 var APIDefinitionSettingsSchema = z.object({
   "use-title": z.optional(z.boolean()).describe("Whether to use the titles of the schemas within an OpenAPI definition as the names of the types within Fern. Defaults to true."),
-  unions: z.optional(z.enum(["v1"])).describe("What version of union generation to use, this will grow over time. Defaults to v0.")
+  unions: z.optional(z.enum(["v1"])).describe("What version of union generation to use, this will grow over time. Defaults to v0."),
+  "message-naming": z.optional(z.enum(["v1", "v2"])).describe("What version of message naming to use for AsyncAPI messages, this will grow over time. Defaults to v1.")
 });
 var APIDefintionWithOverridesSchema = z.object({
   path: APIDefinitionPathSchema,
@@ -1214779,7 +1214780,7 @@ async function convertGeneratorsConfiguration({ absolutePathToGeneratorsConfigur
   };
 }
 async function parseAPIConfiguration(rawGeneratorsConfiguration) {
-  var _a6, _b4, _c4, _d2, _e, _f;
+  var _a6, _b4, _c4, _d2, _e, _f, _g, _h;
   const apiConfiguration = rawGeneratorsConfiguration.api;
   const apiDefinitions = [];
   if (apiConfiguration != null) {
@@ -1214792,7 +1214793,11 @@ async function parseAPIConfiguration(rawGeneratorsConfiguration) {
         origin: void 0,
         overrides: void 0,
         audiences: [],
-        settings: { shouldUseTitleAsName: void 0, shouldUseUndiscriminatedUnionsWithLiterals: void 0 }
+        settings: {
+          shouldUseTitleAsName: void 0,
+          shouldUseUndiscriminatedUnionsWithLiterals: void 0,
+          asyncApiMessageNaming: void 0
+        }
       });
     } else if (isRawProtobufAPIDefinitionSchema(apiConfiguration)) {
       apiDefinitions.push({
@@ -1214805,7 +1214810,11 @@ async function parseAPIConfiguration(rawGeneratorsConfiguration) {
         origin: void 0,
         overrides: apiConfiguration.proto.overrides,
         audiences: [],
-        settings: { shouldUseTitleAsName: void 0, shouldUseUndiscriminatedUnionsWithLiterals: void 0 }
+        settings: {
+          shouldUseTitleAsName: void 0,
+          shouldUseUndiscriminatedUnionsWithLiterals: void 0,
+          asyncApiMessageNaming: void 0
+        }
       });
     } else if (Array.isArray(apiConfiguration)) {
       for (const definition3 of apiConfiguration) {
@@ -1214820,7 +1214829,8 @@ async function parseAPIConfiguration(rawGeneratorsConfiguration) {
             audiences: [],
             settings: {
               shouldUseTitleAsName: void 0,
-              shouldUseUndiscriminatedUnionsWithLiterals: void 0
+              shouldUseUndiscriminatedUnionsWithLiterals: void 0,
+              asyncApiMessageNaming: void 0
             }
           });
         } else if (isRawProtobufAPIDefinitionSchema(definition3)) {
@@ -1214836,7 +1214846,8 @@ async function parseAPIConfiguration(rawGeneratorsConfiguration) {
             audiences: [],
             settings: {
               shouldUseTitleAsName: void 0,
-              shouldUseUndiscriminatedUnionsWithLiterals: void 0
+              shouldUseUndiscriminatedUnionsWithLiterals: void 0,
+              asyncApiMessageNaming: void 0
             }
           });
         } else {
@@ -1214850,7 +1214861,8 @@ async function parseAPIConfiguration(rawGeneratorsConfiguration) {
             audiences: definition3.audiences,
             settings: {
               shouldUseTitleAsName: (_a6 = definition3.settings) == null ? void 0 : _a6["use-title"],
-              shouldUseUndiscriminatedUnionsWithLiterals: ((_b4 = definition3.settings) == null ? void 0 : _b4.unions) === "v1"
+              shouldUseUndiscriminatedUnionsWithLiterals: ((_b4 = definition3.settings) == null ? void 0 : _b4.unions) === "v1",
+              asyncApiMessageNaming: (_c4 = definition3.settings) == null ? void 0 : _c4["message-naming"]
             }
           });
         }
@@ -1214865,8 +1214877,9 @@ async function parseAPIConfiguration(rawGeneratorsConfiguration) {
         overrides: apiConfiguration.overrides,
         audiences: apiConfiguration.audiences,
         settings: {
-          shouldUseTitleAsName: (_c4 = apiConfiguration.settings) == null ? void 0 : _c4["use-title"],
-          shouldUseUndiscriminatedUnionsWithLiterals: ((_d2 = apiConfiguration.settings) == null ? void 0 : _d2.unions) === "v1"
+          shouldUseTitleAsName: (_d2 = apiConfiguration.settings) == null ? void 0 : _d2["use-title"],
+          shouldUseUndiscriminatedUnionsWithLiterals: ((_e = apiConfiguration.settings) == null ? void 0 : _e.unions) === "v1",
+          asyncApiMessageNaming: (_f = apiConfiguration.settings) == null ? void 0 : _f["message-naming"]
         }
       });
     }
@@ -1214887,7 +1214900,8 @@ async function parseAPIConfiguration(rawGeneratorsConfiguration) {
         audiences: [],
         settings: {
           shouldUseTitleAsName: settings == null ? void 0 : settings["use-title"],
-          shouldUseUndiscriminatedUnionsWithLiterals: (settings == null ? void 0 : settings.unions) === "v1"
+          shouldUseUndiscriminatedUnionsWithLiterals: (settings == null ? void 0 : settings.unions) === "v1",
+          asyncApiMessageNaming: void 0
         }
       });
     } else if (openapi != null) {
@@ -1214900,8 +1214914,9 @@ async function parseAPIConfiguration(rawGeneratorsConfiguration) {
         overrides: openapi.overrides,
         audiences: [],
         settings: {
-          shouldUseTitleAsName: (_e = openapi.settings) == null ? void 0 : _e["use-title"],
-          shouldUseUndiscriminatedUnionsWithLiterals: ((_f = openapi.settings) == null ? void 0 : _f.unions) === "v1"
+          shouldUseTitleAsName: (_g = openapi.settings) == null ? void 0 : _g["use-title"],
+          shouldUseUndiscriminatedUnionsWithLiterals: ((_h = openapi.settings) == null ? void 0 : _h.unions) === "v1",
+          asyncApiMessageNaming: void 0
         }
       });
     }
@@ -1214916,7 +1214931,8 @@ async function parseAPIConfiguration(rawGeneratorsConfiguration) {
         audiences: [],
         settings: {
           shouldUseTitleAsName: settings == null ? void 0 : settings["use-title"],
-          shouldUseUndiscriminatedUnionsWithLiterals: (settings == null ? void 0 : settings.unions) === "v1"
+          shouldUseUndiscriminatedUnionsWithLiterals: (settings == null ? void 0 : settings.unions) === "v1",
+          asyncApiMessageNaming: settings == null ? void 0 : settings["message-naming"]
         }
       });
     }
@@ -1217702,7 +1217718,7 @@ var AccessTokenPosthogManager = class {
         properties: {
           ...event,
           ...event.properties,
-          version: "0.37.15",
+          version: "0.37.16",
           usingAccessToken: true
         }
       });
@@ -1217764,7 +1217780,7 @@ var UserPosthogManager = class {
       distinctId: this.userId ?? await this.getPersistedDistinctId(),
       event: "CLI",
       properties: {
-        version: "0.37.15",
+        version: "0.37.16",
         ...event,
         ...event.properties
       }
@@ -1217798,7 +1217814,8 @@ async function getPosthogManager() {
 async function createPosthogManager() {
   try {
     const posthogApiKey = "phc_yQgAEdJJkVpI24NdSRID2mor1x1leRpDoC9yZ9mfXal\n";
-    if (posthogApiKey == null) {
+    const disableTelemetry = process.env.FERN_DISABLE_TELEMETRY === "true";
+    if (posthogApiKey == null || disableTelemetry) {
       return new NoopPosthogManager();
     }
     const userToken = await getUserToken();
@@ -1233546,6 +1233563,11 @@ function buildPathParameter({ pathParameter, context, fileContainingReference })
 // pnp:/home/runner/work/fern/fern/packages/cli/openapi-parser/lib/parse.js
 var import_promises29 = require("fs/promises");
 
+// pnp:/home/runner/work/fern/fern/packages/cli/openapi-parser/lib/asyncapi/options.js
+var DEFAULT_PARSE_ASYNCAPI_SETTINGS = {
+  naming: "v1"
+};
+
 // pnp:/home/runner/work/fern/fern/packages/cli/openapi-parser/lib/getExtension.js
 function getExtension(object4, extension3) {
   const extensions2 = Array.isArray(extension3) ? extension3 : [extension3];
@@ -1235130,8 +1235152,8 @@ function getAllProperties({ schema: schema2, context, breadcrumbs }) {
 }
 
 // pnp:/home/runner/work/fern/fern/packages/cli/openapi-parser/lib/schema/convertUndiscriminatedOneOf.js
-function convertUndiscriminatedOneOf({ nameOverride, generatedName, breadcrumbs, description, availability, wrapAsNullable, context, subtypes, groupName }) {
-  const subtypePrefixes = getUniqueSubTypeNames({ schemas: subtypes });
+function convertUndiscriminatedOneOf({ nameOverride, generatedName, breadcrumbs, description, availability, wrapAsNullable, context, subtypes, groupName, subtypePrefixOverrides }) {
+  const derivedSubtypePrefixes = getUniqueSubTypeNames({ schemas: subtypes });
   const convertedSubtypes = subtypes.flatMap((schema2, index2) => {
     if (!isReferenceObject(schema2) && schema2.enum != null) {
       return schema2.enum.map((enumValue) => {
@@ -1235145,7 +1235167,14 @@ function convertUndiscriminatedOneOf({ nameOverride, generatedName, breadcrumbs,
         });
       });
     }
-    return [convertSchema(schema2, false, context, [...breadcrumbs, subtypePrefixes[index2] ?? `${index2}`])];
+    let subtypePrefix = derivedSubtypePrefixes[index2];
+    if (subtypePrefixOverrides != null) {
+      const override = subtypePrefixOverrides[index2];
+      if (override != null && "name" in override) {
+        subtypePrefix = override.name;
+      }
+    }
+    return [convertSchema(schema2, false, context, [...breadcrumbs, subtypePrefix ?? `${index2}`])];
   });
   const uniqueSubtypes = [];
   for (let i2 = 0; i2 < convertedSubtypes.length; ++i2) {
@@ -1237903,12 +1237932,12 @@ function getFernExamples(channel) {
 }
 
 // pnp:/home/runner/work/fern/fern/packages/cli/openapi-parser/lib/asyncapi/parse.js
-function parseAsyncAPI({ document: document4, taskContext, options: options2 }) {
+function parseAsyncAPI({ document: document4, taskContext, options: options2, asyncApiOptions }) {
   var _a6, _b4, _c4, _d2;
   const breadcrumbs = [];
   if (((_a6 = document4.tags) == null ? void 0 : _a6[0]) != null) {
     breadcrumbs.push(document4.tags[0].name);
-  } else {
+  } else if (asyncApiOptions.naming !== "v2") {
     breadcrumbs.push("websocket");
   }
   const context = new AsyncAPIV2ParserContext({
@@ -1237989,7 +1238018,9 @@ function parseAsyncAPI({ document: document4, taskContext, options: options2 })
         generatedName: channel.publish.operationId ?? "PublishEvent",
         event: channel.publish,
         breadcrumbs,
-        context
+        context,
+        options: options2,
+        asyncApiOptions
       });
     }
     let subscribeSchema = void 0;
@@ -1237998,7 +1238029,9 @@ function parseAsyncAPI({ document: document4, taskContext, options: options2 })
         generatedName: channel.subscribe.operationId ?? "SubscribeEvent",
         event: channel.subscribe,
         breadcrumbs,
-        context
+        context,
+        options: options2,
+        asyncApiOptions
       });
     }
     if (headers.length > 0 || queryParameters.length > 0 || publishSchema != null || subscribeSchema != null) {
@@ -1238068,16 +1238101,29 @@ function parseAsyncAPI({ document: document4, taskContext, options: options2 })
     basePath: getExtension(document4, FernAsyncAPIExtension.BASE_PATH)
   };
 }
-function convertMessageToSchema({ generatedName, event, context, breadcrumbs }) {
+function convertMessageToSchema({ generatedName, event, context, breadcrumbs, options: options2, asyncApiOptions }) {
   if (event.message.oneOf != null) {
     const subtypes = [];
+    const prefixes = [];
     for (const schema2 of event.message.oneOf) {
       let resolvedSchema;
+      let namePrefix = { type: "notFound" };
       if (isReferenceObject(schema2)) {
-        resolvedSchema = context.resolveMessageReference(schema2).payload;
+        const resolvedMessage = context.resolveMessageReference(schema2);
+        if (!isReferenceObject(resolvedMessage.payload) && asyncApiOptions.naming === "v2") {
+          namePrefix = resolvedMessage.name ? { type: "name", name: resolvedMessage.name } : namePrefix;
+          resolvedSchema = {
+            ...resolvedMessage.payload,
+            title: resolvedMessage.name ?? resolvedMessage.payload.title,
+            description: resolvedMessage.name ?? resolvedMessage.payload.description
+          };
+        } else {
+          resolvedSchema = resolvedMessage.payload;
+        }
       } else {
         resolvedSchema = schema2;
       }
+      prefixes.push(namePrefix);
       subtypes.push(resolvedSchema);
     }
     return convertUndiscriminatedOneOf({
@@ -1238089,7 +1238135,8 @@ function convertMessageToSchema({ generatedName, event, context, breadcrumbs })
       groupName: void 0,
       wrapAsNullable: false,
       breadcrumbs,
-      context
+      context,
+      subtypePrefixOverrides: asyncApiOptions.naming === "v2" ? prefixes : []
     });
   }
   return void 0;
@@ -1240487,7 +1240534,8 @@ async function parse4({ specs, taskContext, optionOverrides }) {
       const parsedAsyncAPI = parseAsyncAPI({
         document: asyncAPI,
         taskContext,
-        options: getParseOptions({ specSettings: spec.settings })
+        options: getParseOptions({ specSettings: spec.settings }),
+        asyncApiOptions: getParseAsyncOptions({ specSettings: spec.settings })
       });
       if (parsedAsyncAPI.channel != null) {
         ir.channel.push(parsedAsyncAPI.channel);
@@ -1240515,6 +1240563,11 @@ function getParseOptions({ specSettings, overrides }) {
     audiences: (overrides == null ? void 0 : overrides.audiences) ?? (specSettings == null ? void 0 : specSettings.audiences) ?? DEFAULT_PARSE_OPENAPI_SETTINGS.audiences
   };
 }
+function getParseAsyncOptions({ specSettings, overrides }) {
+  return {
+    naming: (overrides == null ? void 0 : overrides.naming) ?? (specSettings == null ? void 0 : specSettings.asyncApiNaming) ?? DEFAULT_PARSE_ASYNCAPI_SETTINGS.naming
+  };
+}
 function merge3(ir1, ir2) {
   return {
     apiVersion: ir1.apiVersion ?? ir2.apiVersion,
@@ -1242913,7 +1242966,7 @@ function mapValues2(items, mapper) {
 
 // pnp:/home/runner/work/fern/fern/packages/cli/workspace-loader/lib/loadAPIWorkspace.js
 async function loadAPIWorkspace({ absolutePathToWorkspace, context, cliVersion, workspaceName }) {
-  var _a6, _b4, _c4, _d2;
+  var _a6, _b4, _c4, _d2, _e;
   const generatorsConfiguration = await generators_yml_exports.loadGeneratorsConfiguration({
     absolutePathToWorkspace,
     context
@@ -1242996,7 +1243049,8 @@ async function loadAPIWorkspace({ absolutePathToWorkspace, context, cliVersion,
         settings: {
           audiences: definition3.audiences ?? [],
           shouldUseTitleAsName: ((_c4 = definition3.settings) == null ? void 0 : _c4.shouldUseTitleAsName) ?? true,
-          shouldUseUndiscriminatedUnionsWithLiterals: ((_d2 = definition3.settings) == null ? void 0 : _d2.shouldUseUndiscriminatedUnionsWithLiterals) ?? false
+          shouldUseUndiscriminatedUnionsWithLiterals: ((_d2 = definition3.settings) == null ? void 0 : _d2.shouldUseUndiscriminatedUnionsWithLiterals) ?? false,
+          asyncApiNaming: (_e = definition3.settings) == null ? void 0 : _e.asyncApiMessageNaming
         }
       });
     }
@@ -1247161,10 +1247215,10 @@ var CliContext = class {
     return "fern-api";
   }
   getPackageVersion() {
-    if ("0.37.15" == null) {
+    if ("0.37.16" == null) {
       this.logger.error("CLI_VERSION is not defined");
     }
-    return "0.37.15";
+    return "0.37.16";
   }
   getCliName() {
     if ("fern" == null) {
@@ -1255166,7 +1255220,7 @@ var _ApiDefinitionHolder2 = class {
   static getSubpackageId(pkg2) {
     return isSubpackage2(pkg2) ? pkg2.subpackageId : ROOT_PACKAGE_ID2;
   }
-  getSubpackage(subpackageId) {
+  getSubpackageByIdOrLocator(subpackageId) {
     if (subpackageId == null) {
       return void 0;
     } else if (subpackageId === ROOT_PACKAGE_ID2) {
@@ -1255665,7 +1255719,7 @@ _convertPackage = new WeakSet();
 convertPackage_fn = function(pkg2, parentSlug, idgen) {
   const overviewPageId = pkg2.overviewAbsolutePath != null ? navigation_exports2.PageId(this.toRelativeFilepath(pkg2.overviewAbsolutePath)) : void 0;
   const maybeFullSlug = pkg2.overviewAbsolutePath != null ? this.markdownFilesToFullSlugs.get(pkg2.overviewAbsolutePath) : void 0;
-  const subpackage = __privateGet(this, _holder2).getSubpackage(pkg2.package);
+  const subpackage = __privateGet(this, _holder2).getSubpackageByIdOrLocator(pkg2.package);
   if (subpackage != null) {
     const subpackageId = ApiDefinitionHolder2.getSubpackageId(subpackage);
     const subpackageNodeId = idgen.append(subpackageId);
@@ -1255725,16 +1255779,17 @@ convertSection_fn = function(section, parentSlug, idgen) {
   const overviewPageId = section.overviewAbsolutePath != null ? navigation_exports2.PageId(this.toRelativeFilepath(section.overviewAbsolutePath)) : void 0;
   const maybeFullSlug = section.overviewAbsolutePath != null ? this.markdownFilesToFullSlugs.get(section.overviewAbsolutePath) : void 0;
   const nodeId = idgen.append(`section:${kebabCase_default2(section.title)}`);
-  const subpackages = section.referencedSubpackages.filter((subpackageId) => {
-    const subpackage = __privateGet(this, _holder2).getSubpackage(subpackageId);
-    if (subpackage == null) {
+  const subpackageIds = section.referencedSubpackages.map((locator) => {
+    const subpackage = __privateGet(this, _holder2).getSubpackageByIdOrLocator(locator);
+    return subpackage != null ? ApiDefinitionHolder2.getSubpackageId(subpackage) : void 0;
+  }).filter((subpackageId) => {
+    if (subpackageId == null) {
       this.taskContext.logger.error(`Subpackage ${subpackageId} not found in ${this.apiDefinitionId}`);
-      return false;
     }
-    return true;
-  });
-  __privateGet(this, _nodeIdToSubpackageId).set(nodeId.get(), subpackages);
-  subpackages.forEach((subpackageId) => {
+    return subpackageId != null;
+  }).filter(isNonNullish);
+  __privateGet(this, _nodeIdToSubpackageId).set(nodeId.get(), subpackageIds);
+  subpackageIds.forEach((subpackageId) => {
     if (__privateGet(this, _visitedSubpackages2).has(subpackageId)) {
       this.taskContext.logger.error(`Duplicate subpackage found in the API Reference layout: ${subpackageId}`);
     }
@@ -1255765,7 +1255820,7 @@ convertSection_fn = function(section, parentSlug, idgen) {
 _convertUnknownIdentifier = new WeakSet();
 convertUnknownIdentifier_fn = function(unknownIdentifier, apiDefinitionPackageId, parentSlug, idgen) {
   unknownIdentifier = unknownIdentifier.trim();
-  const subpackage = __privateGet(this, _holder2).getSubpackage(unknownIdentifier);
+  const subpackage = __privateGet(this, _holder2).getSubpackageByIdOrLocator(unknownIdentifier);
   if (subpackage != null) {
     const subpackageId = ApiDefinitionHolder2.getSubpackageId(subpackage);
     const subpackageNodeId = idgen.append(subpackageId);
@@ -1255968,7 +1256023,7 @@ convertApiDefinitionPackage_fn = function(pkg2, parentSlug) {
     if (__privateGet(this, _visitedSubpackages2).has(subpackageId)) {
       return;
     }
-    const subpackage = __privateGet(this, _holder2).getSubpackage(subpackageId);
+    const subpackage = __privateGet(this, _holder2).getSubpackageByIdOrLocator(subpackageId);
     if (subpackage == null) {
       this.taskContext.logger.error(`Subpackage ${subpackageId} not found in ${this.apiDefinitionId}`);
       return;
@@ -1256004,7 +1256059,7 @@ convertApiDefinitionPackage_fn = function(pkg2, parentSlug) {
 };
 _convertApiDefinitionPackageId = new WeakSet();
 convertApiDefinitionPackageId_fn = function(packageId, parentSlug) {
-  const pkg2 = packageId != null ? __privateGet(this, _holder2).resolveSubpackage(__privateGet(this, _holder2).getSubpackage(packageId)) : void 0;
+  const pkg2 = packageId != null ? __privateGet(this, _holder2).resolveSubpackage(__privateGet(this, _holder2).getSubpackageByIdOrLocator(packageId)) : void 0;
   if (pkg2 == null) {
     this.taskContext.logger.error(`Subpackage ${packageId} not found in ${this.apiDefinitionId}`);
     return [];
@@ -1317424,6 +1317479,9 @@ async function generateWorkspace({
       context
     });
   } else {
+    if (!token) {
+      return context.failAndThrow("Please run fern login");
+    }
     await runRemoteGenerationForAPIWorkspace({
       projectConfig,
       organization,
@@ -1317455,17 +1317513,21 @@ async function generateAPIWorkspaces({
   preview,
   mode
 }) {
-  const token = await cliContext.runTask(async (context) => {
-    return askToLogin(context);
-  });
-  if (token.type === "user") {
-    await cliContext.runTask(async (context) => {
-      await createOrganizationIfDoesNotExist({
-        organization: project.config.organization,
-        token,
-        context
-      });
+  let token = void 0;
+  if (!useLocalDocker) {
+    const currentToken = await cliContext.runTask(async (context) => {
+      return askToLogin(context);
     });
+    if (currentToken.type === "user") {
+      await cliContext.runTask(async (context) => {
+        await createOrganizationIfDoesNotExist({
+          organization: project.config.organization,
+          token: currentToken,
+          context
+        });
+      });
+    }
+    token = currentToken;
   }
   cliContext.instrumentPostHogEvent({
     orgId: project.config.organization,

package/package.json

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