@fern-api/fern-api-dev 3.57.1 → 3.59.0

package/cli.cjs

@@ -1435488,9 +1435488,47 @@ var ApiSpecSchema = external_exports.union([
   OpenRpcSpecSchema
 ]);
 
+// ../config/lib/schemas/AuthSchemesSchema.js
+var AuthSchemesSchema = external_exports.record(external_exports.string(), external_exports.unknown());
+
+// ../config/lib/schemas/MultipleBaseUrlEnvironmentSchema.js
+var MultipleBaseUrlsEnvironmentSchema = external_exports.object({
+  urls: external_exports.record(external_exports.string(), external_exports.string()),
+  docs: external_exports.string().optional()
+});
+
+// ../config/lib/schemas/SingleBaseUrlEnvironmentSchema.js
+var SingleBaseUrlEnvironmentSchema = external_exports.object({
+  url: external_exports.string(),
+  docs: external_exports.string().optional()
+});
+
+// ../config/lib/schemas/EnvironmentSchema.js
+var EnvironmentSchema = external_exports.union([
+  external_exports.string(),
+  SingleBaseUrlEnvironmentSchema,
+  MultipleBaseUrlsEnvironmentSchema
+]);
+
+// ../config/lib/schemas/HeaderConfigSchema.js
+var HeaderConfigSchema = external_exports.object({
+  name: external_exports.string().optional(),
+  env: external_exports.string().optional(),
+  docs: external_exports.string().optional()
+});
+
+// ../config/lib/schemas/HeaderSchema.js
+var HeaderSchema = external_exports.union([external_exports.string(), HeaderConfigSchema]);
+
 // ../config/lib/schemas/ApiDefinitionSchema.js
 var ApiDefinitionSchema = external_exports.object({
-  specs: external_exports.array(ApiSpecSchema)
+  specs: external_exports.array(ApiSpecSchema),
+  auth: external_exports.string().optional(),
+  defaultUrl: external_exports.string().optional(),
+  defaultEnvironment: external_exports.string().optional(),
+  environments: external_exports.record(external_exports.string(), EnvironmentSchema).optional(),
+  headers: external_exports.record(external_exports.string(), HeaderSchema).optional(),
+  authSchemes: AuthSchemesSchema.optional()
 });
 
 // ../config/lib/schemas/ApisSchema.js
@@ -1436849,8 +1436887,17 @@ var ApiDefinitionConverter = class {
       specs: api.specs,
       sourced: sourcedApi.specs
     });
+    const apiDefinition = {
+      specs,
+      auth: api.auth,
+      authSchemes: api.authSchemes,
+      defaultUrl: api.defaultUrl,
+      defaultEnvironment: api.defaultEnvironment,
+      environments: api.environments,
+      headers: api.headers
+    };
     return {
-      [DEFAULT_API_NAME]: { specs }
+      [DEFAULT_API_NAME]: apiDefinition
     };
   }
   async convertApis({ absoluteFernYmlPath, apis, sourcedApis }) {
@@ -1436868,7 +1436915,15 @@ var ApiDefinitionConverter = class {
         specs: apiDef.specs,
         sourced: sourcedApiDef.specs
       });
-      result[apiName] = { specs };
+      result[apiName] = {
+        specs,
+        auth: apiDef.auth,
+        authSchemes: apiDef.authSchemes,
+        defaultUrl: apiDef.defaultUrl,
+        defaultEnvironment: apiDef.defaultEnvironment,
+        environments: apiDef.environments,
+        headers: apiDef.headers
+      };
     }
     return result;
   }
@@ -1437971,7 +1438026,7 @@ __export(serialization_exports2, {
   EnumSchema: () => EnumSchema,
   EnumValue: () => EnumValue,
   EnumValueSchema: () => EnumValueSchema,
-  EnvironmentSchema: () => EnvironmentSchema,
+  EnvironmentSchema: () => EnvironmentSchema2,
   ErrorDeclarationSchema: () => ErrorDeclarationSchema,
   ErrorDiscriminationSchema: () => ErrorDiscriminationSchema,
   ExampleBodyResponseSchema: () => ExampleBodyResponseSchema,
@@ -1438021,7 +1438076,7 @@ __export(serialization_exports2, {
   InferredGetTokenEndpointSchemaObject: () => InferredGetTokenEndpointSchemaObject,
   ListValidationSchema: () => ListValidationSchema,
   MapValidationSchema: () => MapValidationSchema,
-  MultipleBaseUrlsEnvironmentSchema: () => MultipleBaseUrlsEnvironmentSchema,
+  MultipleBaseUrlsEnvironmentSchema: () => MultipleBaseUrlsEnvironmentSchema2,
   Navigation: () => Navigation,
   NumberValidationSchema: () => NumberValidationSchema,
   OAuthAccessTokenRequestPropertiesSchema: () => OAuthAccessTokenRequestPropertiesSchema,
@@ -1438057,7 +1438112,7 @@ __export(serialization_exports2, {
   RetriesDisabledSchema: () => RetriesDisabledSchema,
   RootApiFileSchema: () => RootApiFileSchema,
   ServiceTransport: () => ServiceTransport,
-  SingleBaseUrlEnvironmentSchema: () => SingleBaseUrlEnvironmentSchema,
+  SingleBaseUrlEnvironmentSchema: () => SingleBaseUrlEnvironmentSchema2,
   SingleUndiscriminatedUnionTypeDetailedSchema: () => SingleUndiscriminatedUnionTypeDetailedSchema,
   SingleUndiscriminatedUnionTypeSchema: () => SingleUndiscriminatedUnionTypeSchema,
   SingleUnionTypeDetailedSchema: () => SingleUnionTypeDetailedSchema,
@@ -1439817,34 +1439872,34 @@ var EncodingSchema = schemas_exports5.object({
 // ../fern-definition/schema/lib/schemas/serialization/resources/environments/index.js
 var environments_exports3 = {};
 __export(environments_exports3, {
-  EnvironmentSchema: () => EnvironmentSchema,
-  MultipleBaseUrlsEnvironmentSchema: () => MultipleBaseUrlsEnvironmentSchema,
-  SingleBaseUrlEnvironmentSchema: () => SingleBaseUrlEnvironmentSchema,
+  EnvironmentSchema: () => EnvironmentSchema2,
+  MultipleBaseUrlsEnvironmentSchema: () => MultipleBaseUrlsEnvironmentSchema2,
+  SingleBaseUrlEnvironmentSchema: () => SingleBaseUrlEnvironmentSchema2,
   WithEnvironmentsSchema: () => WithEnvironmentsSchema
 });
 
 // ../fern-definition/schema/lib/schemas/serialization/resources/environments/types/MultipleBaseUrlsEnvironmentSchema.js
-var MultipleBaseUrlsEnvironmentSchema = schemas_exports5.object({
+var MultipleBaseUrlsEnvironmentSchema2 = schemas_exports5.object({
   urls: schemas_exports5.record(schemas_exports5.string(), schemas_exports5.string())
 }).extend(WithAudiences).extend(WithDocsSchema);
 
 // ../fern-definition/schema/lib/schemas/serialization/resources/environments/types/SingleBaseUrlEnvironmentSchema.js
-var SingleBaseUrlEnvironmentSchema = schemas_exports5.object({
+var SingleBaseUrlEnvironmentSchema2 = schemas_exports5.object({
   url: schemas_exports5.string()
 }).extend(WithAudiences).extend(WithDocsSchema);
 
 // ../fern-definition/schema/lib/schemas/serialization/resources/environments/types/EnvironmentSchema.js
-var EnvironmentSchema = schemas_exports5.undiscriminatedUnion([
+var EnvironmentSchema2 = schemas_exports5.undiscriminatedUnion([
   schemas_exports5.string(),
-  SingleBaseUrlEnvironmentSchema,
-  MultipleBaseUrlsEnvironmentSchema
+  SingleBaseUrlEnvironmentSchema2,
+  MultipleBaseUrlsEnvironmentSchema2
 ]);
 
 // ../fern-definition/schema/lib/schemas/serialization/resources/environments/types/WithEnvironmentsSchema.js
 var WithEnvironmentsSchema = schemas_exports5.object({
   "default-url": schemas_exports5.string().optional(),
   "default-environment": schemas_exports5.string().optional(),
-  environments: schemas_exports5.record(schemas_exports5.string(), EnvironmentSchema).optional()
+  environments: schemas_exports5.record(schemas_exports5.string(), EnvironmentSchema2).optional()
 });
 
 // ../fern-definition/schema/lib/schemas/serialization/resources/errors/index.js
@@ -1469780,7 +1469835,7 @@ __export(fernDefinition_exports2, {
   EncodingSchema: () => EncodingSchema2,
   EndpointSecuritySchema: () => EndpointSecuritySchema2,
   EndpointSecuritySchemaDetails: () => EndpointSecuritySchemaDetails2,
-  EnvironmentSchema: () => EnvironmentSchema2,
+  EnvironmentSchema: () => EnvironmentSchema3,
   HeaderAuthSchemeSchema: () => HeaderAuthSchemeSchema2,
   HttpHeaderSchema: () => HttpHeaderSchema2,
   InferredAuthenticatedRequestHeader: () => InferredAuthenticatedRequestHeader3,
@@ -1469789,7 +1469844,7 @@ __export(fernDefinition_exports2, {
   InferredGetTokenEndpointSchemaObject: () => InferredGetTokenEndpointSchemaObject2,
   ListValidationSchema: () => ListValidationSchema2,
   MapValidationSchema: () => MapValidationSchema2,
-  MultipleBaseUrlsEnvironmentSchema: () => MultipleBaseUrlsEnvironmentSchema2,
+  MultipleBaseUrlsEnvironmentSchema: () => MultipleBaseUrlsEnvironmentSchema3,
   NumberValidationSchema: () => NumberValidationSchema2,
   OAuthAccessTokenRequestPropertiesSchema: () => OAuthAccessTokenRequestPropertiesSchema2,
   OAuthAccessTokenResponsePropertiesSchema: () => OAuthAccessTokenResponsePropertiesSchema2,
@@ -1469799,7 +1469854,7 @@ __export(fernDefinition_exports2, {
   OAuthRefreshTokenResponsePropertiesSchema: () => OAuthRefreshTokenResponsePropertiesSchema2,
   OAuthSchemeSchema: () => OAuthSchemeSchema2,
   ProtobufTypeSchema: () => ProtobufTypeSchema2,
-  SingleBaseUrlEnvironmentSchema: () => SingleBaseUrlEnvironmentSchema2,
+  SingleBaseUrlEnvironmentSchema: () => SingleBaseUrlEnvironmentSchema3,
   StringValidationSchema: () => StringValidationSchema2,
   TokenBearerAuthSchema: () => TokenBearerAuthSchema2,
   TypeReferenceDeclarationWithEnvOverride: () => TypeReferenceDeclarationWithEnvOverride2,
@@ -1470072,34 +1470127,34 @@ var EncodingSchema2 = schemas_exports10.object({
 // ../configuration/lib/generators-yml/schemas/serialization/resources/fernDefinition/resources/environments/index.js
 var environments_exports5 = {};
 __export(environments_exports5, {
-  EnvironmentSchema: () => EnvironmentSchema2,
-  MultipleBaseUrlsEnvironmentSchema: () => MultipleBaseUrlsEnvironmentSchema2,
-  SingleBaseUrlEnvironmentSchema: () => SingleBaseUrlEnvironmentSchema2,
+  EnvironmentSchema: () => EnvironmentSchema3,
+  MultipleBaseUrlsEnvironmentSchema: () => MultipleBaseUrlsEnvironmentSchema3,
+  SingleBaseUrlEnvironmentSchema: () => SingleBaseUrlEnvironmentSchema3,
   WithEnvironmentsSchema: () => WithEnvironmentsSchema2
 });
 
 // ../configuration/lib/generators-yml/schemas/serialization/resources/fernDefinition/resources/environments/types/MultipleBaseUrlsEnvironmentSchema.js
-var MultipleBaseUrlsEnvironmentSchema2 = schemas_exports10.object({
+var MultipleBaseUrlsEnvironmentSchema3 = schemas_exports10.object({
   urls: schemas_exports10.record(schemas_exports10.string(), schemas_exports10.string())
 }).extend(WithAudiences2).extend(WithDocsSchema2);
 
 // ../configuration/lib/generators-yml/schemas/serialization/resources/fernDefinition/resources/environments/types/SingleBaseUrlEnvironmentSchema.js
-var SingleBaseUrlEnvironmentSchema2 = schemas_exports10.object({
+var SingleBaseUrlEnvironmentSchema3 = schemas_exports10.object({
   url: schemas_exports10.string()
 }).extend(WithAudiences2).extend(WithDocsSchema2);
 
 // ../configuration/lib/generators-yml/schemas/serialization/resources/fernDefinition/resources/environments/types/EnvironmentSchema.js
-var EnvironmentSchema2 = schemas_exports10.undiscriminatedUnion([
+var EnvironmentSchema3 = schemas_exports10.undiscriminatedUnion([
   schemas_exports10.string(),
-  SingleBaseUrlEnvironmentSchema2,
-  MultipleBaseUrlsEnvironmentSchema2
+  SingleBaseUrlEnvironmentSchema3,
+  MultipleBaseUrlsEnvironmentSchema3
 ]);
 
 // ../configuration/lib/generators-yml/schemas/serialization/resources/fernDefinition/resources/environments/types/WithEnvironmentsSchema.js
 var WithEnvironmentsSchema2 = schemas_exports10.object({
   "default-url": schemas_exports10.string().optional(),
   "default-environment": schemas_exports10.string().optional(),
-  environments: schemas_exports10.record(schemas_exports10.string(), EnvironmentSchema2).optional()
+  environments: schemas_exports10.record(schemas_exports10.string(), EnvironmentSchema3).optional()
 });
 
 // ../configuration/lib/generators-yml/schemas/serialization/resources/fernDefinition/resources/file/index.js
@@ -1659007,6 +1659062,7 @@ var DocsDefinitionResolver = class {
   markdownFilesToSidebarTitle = /* @__PURE__ */ new Map();
   markdownFilesToNoIndex = /* @__PURE__ */ new Map();
   markdownFilesToTags = /* @__PURE__ */ new Map();
+  markdownFilesToAvailability = /* @__PURE__ */ new Map();
   rawMarkdownFiles = {};
   referencedMarkdownFiles = [];
   async resolve() {
@@ -1659222,7 +1659278,7 @@ var DocsDefinitionResolver = class {
     return relative3(this.docsWorkspace.absoluteFilePath, filepath);
   }
   /**
-   * Extracts all frontmatter data (slug, sidebar-title, noindex, tags) from pages in a single pass.
+   * Extracts all frontmatter data (slug, sidebar-title, noindex, tags, availability) from pages in a single pass.
    * This is more efficient than parsing frontmatter multiple times for each field.
    * @param pages - the pages to extract frontmatter from
    */
@@ -1659253,6 +1659309,38 @@ var DocsDefinitionResolver = class {
       } else if (Array.isArray(tags)) {
         this.markdownFilesToTags.set(absolutePath, tags);
       }
+      const availability = frontmatter.data.availability;
+      if (typeof availability === "string") {
+        const parsedAvailability = this.parseAvailabilityFromFrontmatter(availability);
+        if (parsedAvailability != null) {
+          this.markdownFilesToAvailability.set(absolutePath, parsedAvailability);
+        }
+      }
+    }
+  }
+  /**
+   * Parses an availability string from frontmatter into the Availability enum value.
+   * @param value - the availability string from frontmatter
+   * @returns the Availability enum value, or undefined if the value is not valid
+   */
+  parseAvailabilityFromFrontmatter(value) {
+    const normalizedValue = value.toLowerCase().trim();
+    switch (normalizedValue) {
+      case "stable":
+        return "stable";
+      case "generally-available":
+        return "generally-available";
+      case "in-development":
+        return "in-development";
+      case "pre-release":
+        return "pre-release";
+      case "deprecated":
+        return "deprecated";
+      case "beta":
+        return "beta";
+      default:
+        this.taskContext.logger.warn(`Invalid availability value "${value}" in frontmatter. Valid values are: stable, generally-available, in-development, pre-release, deprecated, beta`);
+        return void 0;
     }
   }
   /**
@@ -1659907,6 +1659995,7 @@ https://buildwithfern.com/learn/docs/getting-started/project-structure#api-defin
       fullSlug: this.markdownFilesToFullSlugs.get(item.absolutePath)?.split("/")
     });
     const id2 = this.#idgen.get(pageId);
+    const frontmatterAvailability = this.markdownFilesToAvailability.get(item.absolutePath);
     return {
       id: id2,
       type: "page",
@@ -1659920,7 +1660009,7 @@ https://buildwithfern.com/learn/docs/getting-started/project-structure#api-defin
       authed: void 0,
       noindex: item.noindex || this.markdownFilesToNoIndex.get(item.absolutePath),
       featureFlags: item.featureFlags,
-      availability: item.availability ?? parentAvailability
+      availability: frontmatterAvailability ?? item.availability ?? parentAvailability
     };
   }
   async toSectionNode({ prefix: prefix2, item, parentSlug, hideChildren, parentAvailability }) {
@@ -1659933,6 +1660022,7 @@ https://buildwithfern.com/learn/docs/getting-started/project-structure#api-defin
       skipUrlSlug: item.skipUrlSlug
     });
     const noindex = item.overviewAbsolutePath != null ? this.markdownFilesToNoIndex.get(item.overviewAbsolutePath) : void 0;
+    const frontmatterAvailability = item.overviewAbsolutePath != null ? this.markdownFilesToAvailability.get(item.overviewAbsolutePath) : void 0;
     const hiddenSection = hideChildren || item.hidden;
     const children2 = await Promise.all(item.contents.map((child) => this.toNavigationChild({
       prefix: id2,
@@ -1659964,7 +1660054,7 @@ https://buildwithfern.com/learn/docs/getting-started/project-structure#api-defin
       pointsTo: void 0,
       noindex,
       featureFlags: item.featureFlags,
-      availability: item.availability ?? parentAvailability
+      availability: frontmatterAvailability ?? item.availability ?? parentAvailability
     };
   }
   async convertTabbedNavigation(prefix2, items, parentSlug) {
@@ -1671594,7 +1671684,7 @@ var LegacyFernWorkspaceAdapter = class {
    * Supports three mutually exclusive modes:
    *  - Fern definition: Uses LazyFernWorkspace
    *  - Conjure definition: Uses ConjureWorkspace
-   *  - OpenAPI/AsyncAPI/Protobuf: Uses OSSWorkspace (can be mixed together)
+   *  - OpenAPI/AsyncAPI/Protobuf/OpenRPC: Uses OSSWorkspace (can be mixed together)
    *
    * Note: Spec combination validation is performed earlier in ApiDefinitionConverter.
    */
@@ -1671607,7 +1671697,7 @@ var LegacyFernWorkspaceAdapter = class {
     if (conjureSpec != null) {
       return this.adaptConjureSpec(conjureSpec);
     }
-    return this.adaptOssSpecs(definition3.specs);
+    return this.adaptOssSpecs(definition3);
   }
   async adaptFernSpec(spec) {
     const workspaceRoot = dirname4(spec.fern);
@@ -1671633,8 +1671723,8 @@ var LegacyFernWorkspaceAdapter = class {
     });
     return conjureWorkspace.toFernWorkspace({ context: this.taskContext });
   }
-  async adaptOssSpecs(specs) {
-    const ossSpecs = specs.filter((spec) => !isFernSpec(spec) && !isConjureSpec(spec));
+  async adaptOssSpecs(definition3) {
+    const ossSpecs = definition3.specs.filter((spec) => !isFernSpec(spec) && !isConjureSpec(spec));
     const specAdapter = new LegacyApiSpecAdapter({ context: this.context });
     const v1Specs = specAdapter.convertAll(ossSpecs);
     const filteredSpecs = v1Specs.filter((spec) => {
@@ -1671652,17 +1671742,46 @@ var LegacyFernWorkspaceAdapter = class {
       }
       return true;
     });
+    const apiConfig = this.buildApiConfiguration(definition3);
     const ossWorkspace = new OSSWorkspace({
       specs: filteredSpecs,
       allSpecs,
       absoluteFilePath: this.context.cwd,
       cliVersion: this.cliVersion,
+      generatorsConfiguration: apiConfig != null ? this.buildGeneratorsConfiguration(apiConfig) : void 0,
       workspaceName: void 0,
-      generatorsConfiguration: void 0,
       changelog: void 0
     });
     return ossWorkspace.toFernWorkspace({ context: this.taskContext });
   }
+  buildApiConfiguration(definition3) {
+    if (definition3.auth == null && definition3.authSchemes == null && definition3.environments == null && definition3.headers == null && definition3.defaultUrl == null && definition3.defaultEnvironment == null) {
+      return void 0;
+    }
+    return {
+      type: "singleNamespace",
+      definitions: [],
+      auth: definition3.auth,
+      "auth-schemes": definition3.authSchemes,
+      "default-url": definition3.defaultUrl,
+      "default-environment": definition3.defaultEnvironment,
+      environments: definition3.environments,
+      headers: definition3.headers
+    };
+  }
+  buildGeneratorsConfiguration(apiConfig) {
+    return {
+      absolutePathToConfiguration: AbsoluteFilePath2.of(this.context.cwd),
+      api: apiConfig,
+      defaultGroup: void 0,
+      groupAliases: {},
+      reviewers: void 0,
+      groups: [],
+      whitelabel: void 0,
+      ai: void 0,
+      rawConfiguration: {}
+    };
+  }
 };
 
 // ../cli-v2/lib/sdk/adapter/LegacyGeneratorInvocationAdapter.js
@@ -1678733,7 +1678852,7 @@ var AccessTokenPosthogManager = class {
         properties: {
           ...event,
           ...event.properties,
-          version: "3.57.1",
+          version: "3.59.0",
           usingAccessToken: true
         }
       });
@@ -1678783,7 +1678902,7 @@ var UserPosthogManager = class {
       distinctId: this.userId ?? await this.getPersistedDistinctId(),
       event: "CLI",
       properties: {
-        version: "3.57.1",
+        version: "3.59.0",
         ...event,
         ...event.properties,
         usingAccessToken: false,
@@ -1710705,7 +1710824,7 @@ var CliContext = class {
     if (false) {
       this.logger.error("CLI_VERSION is not defined");
     }
-    return "3.57.1";
+    return "3.59.0";
   }
   getCliName() {
     if (false) {
@@ -1713819,7 +1713938,7 @@ var import_path56 = __toESM(require("path"), 1);
 var LOCAL_STORAGE_FOLDER4 = ".fern-dev";
 var LOGS_FOLDER_NAME = "logs";
 function getCliSource() {
-  const version7 = "3.57.1";
+  const version7 = "3.59.0";
   return `cli@${version7}`;
 }
 var DebugLogger = class {
@@ -1741264,7 +1741383,7 @@ async function runCli() {
   await exit3();
 }
 async function tryRunCli(cliContext) {
-  const cli = yargs_default2(hideBin(process.argv)).scriptName(cliContext.environment.cliName).version(false).fail((message, error49, argv) => {
+  const cli = yargs_default2(hideBin(process.argv)).scriptName(cliContext.environment.cliName).version(false).completion("completion", "Generate shell completion script").fail((message, error49, argv) => {
     if (error49 == null) {
       argv.showHelp();
       cliContext.logger.error(message);

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.57.1",
+  "version": "3.59.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/fern-api/fern.git",