fern-api 0.19.0-rc2 → 0.19.0-rc4

package/bundle.cjs

@@ -795422,6 +795422,17 @@ var GeneratorGroupSchema = z.strictObject({
   generators: z.array(GeneratorInvocationSchema)
 });
 
+// pnp:/home/circleci/project/packages/cli/config-management/generators-configuration/lib/schemas/GeneratorsOpenAPIObjectSchema.js
+var OPENAPI_DISABLE_EXAMPLES_KEY = "disable-examples";
+var GeneratorsOpenAPIObjectSchema = z.strictObject({
+  path: z.optional(z.string()),
+  overrides: z.optional(z.string()),
+  [OPENAPI_DISABLE_EXAMPLES_KEY]: z.optional(z.boolean())
+});
+
+// pnp:/home/circleci/project/packages/cli/config-management/generators-configuration/lib/schemas/GeneratorsOpenAPISchema.js
+var GeneratorsOpenAPISchema = z.union([GeneratorsOpenAPIObjectSchema, z.string()]);
+
 // pnp:/home/circleci/project/packages/cli/config-management/generators-configuration/lib/schemas/WhitelabelGithubConfigurationSchema.js
 var WhitelabelGithubConfigurationSchema = z.strictObject({
   username: z.string(),
@@ -795441,8 +795452,8 @@ var OPENAPI_OVERRIDES_LOCATION_KEY = "openapi-overrides";
 var ASYNC_API_LOCATION_KEY = "async-api";
 var GeneratorsConfigurationSchema = z.strictObject({
   [DEFAULT_GROUP_GENERATORS_CONFIG_KEY]: z.optional(z.string()),
-  [OPENAPI_LOCATION_KEY]: z.optional(z.string()),
-  [OPENAPI_OVERRIDES_LOCATION_KEY]: z.optional(z.string()),
+  [OPENAPI_LOCATION_KEY]: z.optional(GeneratorsOpenAPISchema),
+  [OPENAPI_OVERRIDES_LOCATION_KEY]: z.optional(z.string()).describe("Deprecated; use openapi.overrides instead."),
   [ASYNC_API_LOCATION_KEY]: z.optional(z.string()),
   whitelabel: z.optional(WhitelabelConfigurationSchema),
   groups: z.optional(z.record(GeneratorGroupSchema))
@@ -795450,14 +795461,14 @@ var GeneratorsConfigurationSchema = z.strictObject({
 
 // pnp:/home/circleci/project/packages/cli/config-management/generators-configuration/lib/convertGeneratorsConfiguration.js
 async function convertGeneratorsConfiguration({ absolutePathToGeneratorsConfiguration, rawGeneratorsConfiguration }) {
-  const pathToOpenAPI = rawGeneratorsConfiguration[OPENAPI_LOCATION_KEY];
+  const openAPI = await parseOpenAPIConfiguration(rawGeneratorsConfiguration);
   const pathToAsyncAPI = rawGeneratorsConfiguration[ASYNC_API_LOCATION_KEY];
-  const pathToOpenAPIOverrides = rawGeneratorsConfiguration[OPENAPI_OVERRIDES_LOCATION_KEY];
   return {
     absolutePathToConfiguration: absolutePathToGeneratorsConfiguration,
     absolutePathToAsyncAPI: pathToAsyncAPI != null ? join(dirname(absolutePathToGeneratorsConfiguration), RelativeFilePath.of(pathToAsyncAPI)) : void 0,
-    absolutePathToOpenAPI: pathToOpenAPI != null ? join(dirname(absolutePathToGeneratorsConfiguration), RelativeFilePath.of(pathToOpenAPI)) : void 0,
-    absolutePathToOpenAPIOverrides: pathToOpenAPIOverrides != null ? join(dirname(absolutePathToGeneratorsConfiguration), RelativeFilePath.of(pathToOpenAPIOverrides)) : void 0,
+    absolutePathToOpenAPI: openAPI.path != null ? join(dirname(absolutePathToGeneratorsConfiguration), RelativeFilePath.of(openAPI.path)) : void 0,
+    absolutePathToOpenAPIOverrides: openAPI.overrides != null ? join(dirname(absolutePathToGeneratorsConfiguration), RelativeFilePath.of(openAPI.overrides)) : void 0,
+    disableOpenAPIExamples: openAPI.disableExamples,
     rawConfiguration: rawGeneratorsConfiguration,
     defaultGroup: rawGeneratorsConfiguration["default-group"],
     groups: rawGeneratorsConfiguration.groups != null ? await Promise.all(Object.entries(rawGeneratorsConfiguration.groups).map(([groupName, group]) => convertGroup({
@@ -795470,6 +795481,21 @@ async function convertGeneratorsConfiguration({ absolutePathToGeneratorsConfigur
     } : void 0
   };
 }
+async function parseOpenAPIConfiguration(rawGeneratorsConfiguration) {
+  const openAPI = rawGeneratorsConfiguration[OPENAPI_LOCATION_KEY];
+  if (typeof openAPI === "string") {
+    return {
+      path: openAPI,
+      overrides: rawGeneratorsConfiguration[OPENAPI_OVERRIDES_LOCATION_KEY],
+      disableExamples: void 0
+    };
+  }
+  return {
+    path: openAPI == null ? void 0 : openAPI.path,
+    overrides: (openAPI == null ? void 0 : openAPI.overrides) ?? rawGeneratorsConfiguration[OPENAPI_OVERRIDES_LOCATION_KEY],
+    disableExamples: openAPI == null ? void 0 : openAPI[OPENAPI_DISABLE_EXAMPLES_KEY]
+  };
+}
 async function convertGroup({ absolutePathToGeneratorsConfiguration, groupName, group }) {
   return {
     groupName,
@@ -799111,7 +799137,7 @@ var AccessTokenPosthogManager = class {
         properties: {
           ...event,
           ...event.properties,
-          version: "0.19.0-rc2",
+          version: "0.19.0-rc4",
           usingAccessToken: true
         }
       });
@@ -799173,7 +799199,7 @@ var UserPosthogManager = class {
       distinctId: this.userId ?? await this.getPersistedDistinctId(),
       event: "CLI",
       properties: {
-        version: "0.19.0-rc2",
+        version: "0.19.0-rc4",
         ...event,
         ...event.properties
       }
@@ -816625,7 +816651,7 @@ function replaceWithSchemaReference({ openapi, replaceReference, schemaReference
 }
 
 // pnp:/home/circleci/project/packages/cli/openapi-parser/lib/openapi/v3/generateIr.js
-function generateIr(openApi, taskContext) {
+function generateIr({ openApi, taskContext, disableExamples }) {
   var _a2, _b2, _c2;
   openApi = runResolutions({ openapi: openApi });
   const securitySchemes = Object.fromEntries(Object.entries(((_a2 = openApi.components) == null ? void 0 : _a2.securitySchemes) ?? {}).map(([key2, securityScheme]) => {
@@ -816701,7 +816727,7 @@ function generateIr(openApi, taskContext) {
   const exampleEndpointFactory = new ExampleEndpointFactory(schemasWithExample, context.logger);
   const endpoints = endpointsWithExample.map((endpointWithExample) => {
     let examples = endpointWithExample.examples;
-    if (examples.length === 0 || examples.every(hasIncompleteExample)) {
+    if (!disableExamples && (examples.length === 0 || examples.every(hasIncompleteExample))) {
       const endpointExample = exampleEndpointFactory.buildEndpointExample(endpointWithExample);
       if (endpointExample != null) {
         examples = [endpointExample, ...endpointWithExample.examples];
@@ -816837,13 +816863,17 @@ function hasIncompleteExample(example) {
 }
 
 // pnp:/home/circleci/project/packages/cli/openapi-parser/lib/openapi/v2/generateIr.js
-async function generateIr2(openApi, taskContext) {
+async function generateIr2({ openApi, taskContext, disableExamples }) {
   const conversionResult = await (0, import_swagger2openapi.convertObj)(openApi, {});
-  return generateIr(conversionResult.openapi, taskContext);
+  return generateIr({
+    openApi: conversionResult.openapi,
+    taskContext,
+    disableExamples
+  });
 }
 
 // pnp:/home/circleci/project/packages/cli/openapi-parser/lib/openapi/parse.js
-async function parse2({ absolutePathToAsyncAPI, absolutePathToOpenAPI, absolutePathToOpenAPIOverrides, taskContext }) {
+async function parse2({ absolutePathToAsyncAPI, absolutePathToOpenAPI, absolutePathToOpenAPIOverrides, disableExamples, taskContext }) {
   let parsedAsyncAPI = {
     schemas: {},
     channel: void 0
@@ -816859,9 +816889,17 @@ async function parse2({ absolutePathToAsyncAPI, absolutePathToOpenAPI, absoluteP
   });
   let openApiIr = void 0;
   if (isOpenApiV3(openApiDocument)) {
-    openApiIr = generateIr(openApiDocument, taskContext);
+    openApiIr = generateIr({
+      openApi: openApiDocument,
+      taskContext,
+      disableExamples
+    });
   } else if (isOpenApiV2(openApiDocument)) {
-    openApiIr = await generateIr2(openApiDocument, taskContext);
+    openApiIr = await generateIr2({
+      openApi: openApiDocument,
+      taskContext,
+      disableExamples
+    });
   }
   if (openApiIr != null) {
     return {
@@ -817366,6 +817404,107 @@ function buildEnvironments(context) {
   }
 }
 
+// pnp:/home/circleci/project/packages/cli/openapi-ir-to-fern/lib/utils/getEndpointLocation.js
+function getEndpointLocation(endpoint) {
+  if (endpoint.sdkName != null) {
+    const filename = endpoint.sdkName.groupName.length === 0 ? "__package__.yml" : `${endpoint.sdkName.groupName.map((part) => camelCase_default(part)).join("/")}.yml`;
+    return {
+      file: RelativeFilePath.of(filename),
+      endpointId: endpoint.sdkName.methodName
+    };
+  }
+  const tag = endpoint.tags[0];
+  const operationId = endpoint.operationId;
+  if (operationId == null) {
+    if (tag != null) {
+      return {
+        file: RelativeFilePath.of(`${camelCase_default(tag)}.yml`),
+        endpointId: endpoint.summary != null ? camelCase_default(endpoint.summary) : camelCase_default(`${endpoint.method}_${endpoint.path.split("/").join("_")}`)
+      };
+    }
+    if (endpoint.summary != null) {
+      return {
+        file: RelativeFilePath.of(FERN_PACKAGE_MARKER_FILENAME),
+        endpointId: camelCase_default(endpoint.summary)
+      };
+    }
+    return {
+      file: RelativeFilePath.of(FERN_PACKAGE_MARKER_FILENAME),
+      endpointId: camelCase_default(`${endpoint.method}_${endpoint.path.split("/").join("_")}`)
+    };
+  }
+  if (tag == null) {
+    return {
+      file: RelativeFilePath.of(FERN_PACKAGE_MARKER_FILENAME),
+      endpointId: operationId
+    };
+  }
+  const tagTokens = tokenizeString(tag);
+  const operationIdTokens = tokenizeString(operationId);
+  if (isEqual_default(tagTokens, operationIdTokens)) {
+    return {
+      file: RelativeFilePath.of("__package__.yml"),
+      endpointId: tag
+    };
+  }
+  const fastapiEndpointLocation = maybeGetFastApiEndpointLocation({
+    operationId,
+    tag,
+    path: endpoint.path,
+    method: endpoint.method
+  });
+  if (fastapiEndpointLocation != null) {
+    return fastapiEndpointLocation;
+  }
+  const fileParts = [];
+  for (let i2 = 0; i2 < tagTokens.length; ++i2) {
+    const tagElement = tagTokens[i2];
+    if (tagElement != null && tagElement === operationIdTokens[i2]) {
+      fileParts.push(tagElement);
+    } else {
+      const camelCasedTag = camelCase_default(tag);
+      return {
+        file: RelativeFilePath.of(`${camelCasedTag}.yml`),
+        endpointId: operationId,
+        tag
+      };
+    }
+  }
+  if (fileParts.length >= operationIdTokens.length) {
+    throw new Error(`Cannot get file for endpoint ${JSON.stringify(endpoint)}`);
+  }
+  return {
+    file: RelativeFilePath.of(camelCase_default(fileParts.join("_")) + ".yml"),
+    endpointId: camelCase_default(operationIdTokens.slice(fileParts.length).join("_")),
+    tag
+  };
+}
+function tokenizeString(input) {
+  let tokens;
+  if (/^[a-z]+(?:[A-Z][a-z]+)*$/.test(input)) {
+    tokens = input.split(/(?=[A-Z])/);
+  } else {
+    tokens = input.split(/[^a-zA-Z0-9]+/);
+  }
+  tokens = tokens.map((token) => token.toLowerCase());
+  tokens = compact_default(tokens);
+  return tokens;
+}
+var NON_ALPHANUMERIC_EXCEPT_BRACES_REGEX = new RegExp("[^a-zA-Z0-9{}]+");
+var BRACE_REGEX = new RegExp("[{}]", "g");
+function maybeGetFastApiEndpointLocation({ operationId, tag, path: path33, method: method2 }) {
+  const pathSegment = path33.split(NON_ALPHANUMERIC_EXCEPT_BRACES_REGEX).join("_").replaceAll(BRACE_REGEX, "_");
+  const operationIdSuffix = `${pathSegment}_${method2.toLowerCase()}`;
+  if (operationId.endsWith(operationIdSuffix)) {
+    return {
+      file: RelativeFilePath.of(camelCase_default(tag) + ".yml"),
+      endpointId: camelCase_default(operationId.slice(0, -1 * operationIdSuffix.length)),
+      tag
+    };
+  }
+  return void 0;
+}
+
 // pnp:/home/circleci/project/packages/cli/openapi-ir-to-fern/lib/utils/wrapTypeReferenceAsOptional.js
 function wrapTypeReferenceAsOptional(typeReference) {
   const type2 = getTypeFromTypeReference(typeReference);
@@ -817399,11 +817538,12 @@ function buildGlobalHeaders(context) {
       if (HEADERS_TO_IGNORE.has(header.name)) {
         continue;
       }
+      const { file } = getEndpointLocation(endpoint);
       let headerWithCount = globalHeaders[header.name];
       if (headerWithCount == null) {
         const convertedHeader = buildHeader({
           header,
-          fileContainingReference: RelativeFilePath.of(FERN_PACKAGE_MARKER_FILENAME),
+          fileContainingReference: RelativeFilePath.of(ROOT_API_FILENAME),
           context
         });
         headerWithCount = new HeaderWithCount(convertedHeader);
@@ -817953,107 +818093,6 @@ function getRequest({ declarationFile, context, request, requestNameOverride, ge
   }
 }
 
-// pnp:/home/circleci/project/packages/cli/openapi-ir-to-fern/lib/utils/getEndpointLocation.js
-function getEndpointLocation(endpoint) {
-  if (endpoint.sdkName != null) {
-    const filename = endpoint.sdkName.groupName.length === 0 ? "__package__.yml" : `${endpoint.sdkName.groupName.map((part) => camelCase_default(part)).join("/")}.yml`;
-    return {
-      file: RelativeFilePath.of(filename),
-      endpointId: endpoint.sdkName.methodName
-    };
-  }
-  const tag = endpoint.tags[0];
-  const operationId = endpoint.operationId;
-  if (operationId == null) {
-    if (tag != null) {
-      return {
-        file: RelativeFilePath.of(`${camelCase_default(tag)}.yml`),
-        endpointId: endpoint.summary != null ? camelCase_default(endpoint.summary) : camelCase_default(`${endpoint.method}_${endpoint.path.split("/").join("_")}`)
-      };
-    }
-    if (endpoint.summary != null) {
-      return {
-        file: RelativeFilePath.of(FERN_PACKAGE_MARKER_FILENAME),
-        endpointId: camelCase_default(endpoint.summary)
-      };
-    }
-    return {
-      file: RelativeFilePath.of(FERN_PACKAGE_MARKER_FILENAME),
-      endpointId: camelCase_default(`${endpoint.method}_${endpoint.path.split("/").join("_")}`)
-    };
-  }
-  if (tag == null) {
-    return {
-      file: RelativeFilePath.of(FERN_PACKAGE_MARKER_FILENAME),
-      endpointId: operationId
-    };
-  }
-  const tagTokens = tokenizeString(tag);
-  const operationIdTokens = tokenizeString(operationId);
-  if (isEqual_default(tagTokens, operationIdTokens)) {
-    return {
-      file: RelativeFilePath.of("__package__.yml"),
-      endpointId: tag
-    };
-  }
-  const fastapiEndpointLocation = maybeGetFastApiEndpointLocation({
-    operationId,
-    tag,
-    path: endpoint.path,
-    method: endpoint.method
-  });
-  if (fastapiEndpointLocation != null) {
-    return fastapiEndpointLocation;
-  }
-  const fileParts = [];
-  for (let i2 = 0; i2 < tagTokens.length; ++i2) {
-    const tagElement = tagTokens[i2];
-    if (tagElement != null && tagElement === operationIdTokens[i2]) {
-      fileParts.push(tagElement);
-    } else {
-      const camelCasedTag = camelCase_default(tag);
-      return {
-        file: RelativeFilePath.of(`${camelCasedTag}.yml`),
-        endpointId: operationId,
-        tag
-      };
-    }
-  }
-  if (fileParts.length >= operationIdTokens.length) {
-    throw new Error(`Cannot get file for endpoint ${JSON.stringify(endpoint)}`);
-  }
-  return {
-    file: RelativeFilePath.of(camelCase_default(fileParts.join("_")) + ".yml"),
-    endpointId: camelCase_default(operationIdTokens.slice(fileParts.length).join("_")),
-    tag
-  };
-}
-function tokenizeString(input) {
-  let tokens;
-  if (/^[a-z]+(?:[A-Z][a-z]+)*$/.test(input)) {
-    tokens = input.split(/(?=[A-Z])/);
-  } else {
-    tokens = input.split(/[^a-zA-Z0-9]+/);
-  }
-  tokens = tokens.map((token) => token.toLowerCase());
-  tokens = compact_default(tokens);
-  return tokens;
-}
-var NON_ALPHANUMERIC_EXCEPT_BRACES_REGEX = new RegExp("[^a-zA-Z0-9{}]+");
-var BRACE_REGEX = new RegExp("[{}]", "g");
-function maybeGetFastApiEndpointLocation({ operationId, tag, path: path33, method: method2 }) {
-  const pathSegment = path33.split(NON_ALPHANUMERIC_EXCEPT_BRACES_REGEX).join("_").replaceAll(BRACE_REGEX, "_");
-  const operationIdSuffix = `${pathSegment}_${method2.toLowerCase()}`;
-  if (operationId.endsWith(operationIdSuffix)) {
-    return {
-      file: RelativeFilePath.of(camelCase_default(tag) + ".yml"),
-      endpointId: camelCase_default(operationId.slice(0, -1 * operationIdSuffix.length)),
-      tag
-    };
-  }
-  return void 0;
-}
-
 // pnp:/home/circleci/project/packages/cli/openapi-ir-to-fern/lib/buildServices.js
 function buildServices(context) {
   const sdkGroups = /* @__PURE__ */ new Set();
@@ -818374,6 +818413,13 @@ var FernDefinitionBuilderImpl = class {
       return void 0;
     }
     const importPrefix = camelCase_default((0, import_path16.basename)(fileToImport, (0, import_path16.extname)(fileToImport)).replaceAll("__package__", "root"));
+    if (file === RelativeFilePath.of(ROOT_API_FILENAME)) {
+      if (this.rootApiFile.imports == null) {
+        this.rootApiFile.imports = {};
+      }
+      this.rootApiFile.imports[importPrefix] = relative(dirname(AbsoluteFilePath.of(`/${file}`)), AbsoluteFilePath.of(`/${fileToImport}`));
+      return importPrefix;
+    }
     const fernFile = this.getOrCreateFile(file);
     if (fernFile.imports == null) {
       fernFile.imports = {};
@@ -818604,11 +818650,12 @@ function convert2({ openApiIr, taskContext }) {
 
 // pnp:/home/circleci/project/packages/cli/workspace-loader/lib/utils/convertOpenApiWorkspaceToFernWorkspace.js
 async function getOpenAPIIRFromOpenAPIWorkspace(openapiWorkspace, context) {
-  var _a2;
+  var _a2, _b2;
   return await parse2({
     absolutePathToAsyncAPI: openapiWorkspace.absolutePathToAsyncAPI,
     absolutePathToOpenAPI: openapiWorkspace.absolutePathToOpenAPI,
     absolutePathToOpenAPIOverrides: (_a2 = openapiWorkspace.generatorsConfiguration) == null ? void 0 : _a2.absolutePathToOpenAPIOverrides,
+    disableExamples: (_b2 = openapiWorkspace.generatorsConfiguration) == null ? void 0 : _b2.disableOpenAPIExamples,
     taskContext: context
   });
 }
@@ -825867,10 +825914,10 @@ var CliContext = class {
     return "fern-api";
   }
   getPackageVersion() {
-    if ("0.19.0-rc2" == null) {
+    if ("0.19.0-rc4" == null) {
       this.logger.error("CLI_VERSION is not defined");
     }
-    return "0.19.0-rc2";
+    return "0.19.0-rc4";
   }
   getCliName() {
     if ("fern" == null) {

package/package.json

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