fern-api 0.19.0-rc1 → 0.19.0-rc3

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-rc1",
+          version: "0.19.0-rc3",
           usingAccessToken: true
         }
       });
@@ -799173,7 +799199,7 @@ var UserPosthogManager = class {
       distinctId: this.userId ?? await this.getPersistedDistinctId(),
       event: "CLI",
       properties: {
-        version: "0.19.0-rc1",
+        version: "0.19.0-rc3",
         ...event,
         ...event.properties
       }
@@ -814027,7 +814053,13 @@ var ExampleTypeFactory = class {
     this.schemas = schemas;
   }
   buildExample({ schema: schema2, example, options }) {
-    return this.buildExampleHelper({ schema: schema2, visitedSchemaIds: /* @__PURE__ */ new Set(), example, options, depth: 0 });
+    return this.buildExampleHelper({
+      schema: schema2,
+      visitedSchemaIds: /* @__PURE__ */ new Set(),
+      example,
+      options: { ...options, maxCheckerDepth: options.maxCheckerDepth ?? 5 },
+      depth: 0
+    });
   }
   buildExampleHelper({ example, schema: schema2, depth, visitedSchemaIds, options }) {
     var _a2, _b2;
@@ -814040,7 +814072,7 @@ var ExampleTypeFactory = class {
       case "literal":
         return FullExample.literal(schema2.value);
       case "nullable": {
-        if (example == null && !this.hasExample(schema2.value) && (options.ignoreOptionals || this.exceedsMaxDepth(depth, options))) {
+        if (example == null && !this.hasExample(schema2.value, 0, visitedSchemaIds, options) && (options.ignoreOptionals || this.exceedsMaxDepth(depth, options))) {
           return void 0;
         }
         const result2 = this.buildExampleHelper({
@@ -814062,7 +814094,7 @@ var ExampleTypeFactory = class {
         return result2;
       }
       case "optional": {
-        if (example == null && !this.hasExample(schema2.value) && (options.ignoreOptionals || this.exceedsMaxDepth(depth, options))) {
+        if (example == null && !this.hasExample(schema2.value, 0, visitedSchemaIds, options) && (options.ignoreOptionals || this.exceedsMaxDepth(depth, options))) {
           return void 0;
         }
         const result2 = this.buildExampleHelper({
@@ -814317,23 +814349,26 @@ var ExampleTypeFactory = class {
         assertNever(schema2);
     }
   }
-  hasExample(schema2) {
+  hasExample(schema2, depth, visitedSchemaIds = /* @__PURE__ */ new Set(), options) {
+    if (this.exceedsMaxCheckerDepth(depth, options)) {
+      return false;
+    }
     switch (schema2.type) {
       case "array":
-        return this.hasExample(schema2.value);
+        return this.hasExample(schema2.value, depth + 1, visitedSchemaIds, options);
       case "enum":
         return schema2.example != null;
       case "literal":
         return false;
       case "map":
-        return schema2.key.schema.example != null && this.hasExample(schema2.value);
+        return schema2.key.schema.example != null && this.hasExample(schema2.value, depth + 1, visitedSchemaIds, options);
       case "object": {
         const objectExample = schema2.fullExamples != null && schema2.fullExamples.length > 0;
         if (objectExample) {
           return true;
         }
         for (const property5 of schema2.properties) {
-          if (this.hasExample(property5.schema)) {
+          if (this.hasExample(property5.schema, depth + 1, visitedSchemaIds, options)) {
             return true;
           }
         }
@@ -814343,19 +814378,25 @@ var ExampleTypeFactory = class {
         return schema2.schema.example != null;
       case "reference": {
         const resolvedSchema = this.schemas[schema2.schema];
-        if (resolvedSchema != null) {
-          return this.hasExample(resolvedSchema);
+        if (resolvedSchema != null && !visitedSchemaIds.has(schema2.schema)) {
+          visitedSchemaIds.add(schema2.schema);
+          const hasExample = this.hasExample(resolvedSchema, depth, visitedSchemaIds, options);
+          visitedSchemaIds.delete(schema2.schema);
+          return hasExample;
         }
         return false;
       }
       case "unknown":
         return schema2.example != null;
       case "oneOf":
-        return Object.values(schema2.value.schemas).some((schema3) => this.hasExample(schema3));
+        return Object.values(schema2.value.schemas).some((schema3) => this.hasExample(schema3, depth, visitedSchemaIds, options));
       default:
         return false;
     }
   }
+  exceedsMaxCheckerDepth(depth, options) {
+    return depth > (options.maxCheckerDepth ?? 0);
+  }
   exceedsMaxDepth(depth, options) {
     return depth > (options.maxDepth ?? 0);
   }
@@ -816610,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]) => {
@@ -816686,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];
@@ -816822,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
@@ -816844,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 {
@@ -818589,11 +818642,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
   });
 }
@@ -825852,10 +825906,10 @@ var CliContext = class {
     return "fern-api";
   }
   getPackageVersion() {
-    if ("0.19.0-rc1" == null) {
+    if ("0.19.0-rc3" == null) {
       this.logger.error("CLI_VERSION is not defined");
     }
-    return "0.19.0-rc1";
+    return "0.19.0-rc3";
   }
   getCliName() {
     if ("fern" == null) {

package/package.json

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